Version Protobuild at 1.17.400, and update help format (Protobuild#261)

.gitignore

@@ -113,3 +113,5 @@ Protobuild.FunctionalTests/TestData/SafeResolveDefaultsWithoutFeatureSet/Package
 Protobuild.FunctionalTests/TestData/ModuleInfoGetsUpgraded/xunit/
 .vs/
 Protobuild.FunctionalTests/TestData/NuGet3PackageContentFallback/RestSharp/
+
+/Protobuild.Internal/ProtobuildVersion.cs

Build/AdditionalProjectTransforms.xslt

@@ -0,0 +1,21 @@
+<xsl:if test="$root/Input/Generation/ProjectName = 'Protobuild.Internal'">
+  <Target Name="GenerateProtobuildVersion" BeforeTargets="BeforeBuild">
+    <Exec>
+      <xsl:attribute name="WorkingDirectory">
+        <xsl:value-of select="$root/Input/Generation/RootPath" />
+        <xsl:value-of select="$project/@Path" />
+      </xsl:attribute>
+      <xsl:attribute name="Command">
+        <xsl:if test="$root/Input/Generation/HostPlatform = 'Linux'">
+          <xsl:text>bash ../Build/GenerateVersion.sh</xsl:text>
+        </xsl:if>
+        <xsl:if test="$root/Input/Generation/HostPlatform = 'MacOS'">
+          <xsl:text>bash ../Build/GenerateVersion.sh</xsl:text>
+        </xsl:if>
+        <xsl:if test="$root/Input/Generation/HostPlatform = 'Windows'">
+          <xsl:text>powershell -ExecutionPolicy Bypass ..\Build\GenerateVersion.ps1</xsl:text>
+        </xsl:if>
+      </xsl:attribute>
+    </Exec>
+  </Target>
+</xsl:if>

Build/GenerateVersion.ps1

@@ -0,0 +1,32 @@
+param()
+
+[xml]$ModuleDocument = Get-Content -Path $PSScriptRoot\Module.xml
+
+$SemanticVersion = $ModuleDocument.Module.SemanticVersion
+$BuildDate = Get-Date -Date ((Get-Date).ToUniversalTime()) -UFormat "+%Y-%m-%d %H:%M:%S"
+$BuildDate = "$BuildDate UTC"
+$BuildCommit = $(git rev-parse HEAD)
+$JenkinsGitBranch = $env:GIT_BRANCH
+if ($JenkinsGitBranch -ne "" -and $JenkinsGitBranch -ne $null) {
+  $BuildCommit = "$BuildCommit; $JenkinsGitBranch"
+}
+$BuildIsDirty = "false"
+if ( ((git status --porcelain) | Out-String) -ne "" ) {
+  $BuildIsDirty = "true"
+}
+
+Write-Output @"
+namespace Protobuild
+{
+    public static class ProtobuildVersion
+    {
+        public const string SemanticVersion = "$SemanticVersion";
+
+        public const string BuildDate = "$BuildDate";
+
+        public const string BuildCommit = "$BuildCommit";
+
+        public const bool BuiltWithPendingChanges = $BuildIsDirty;
+    }
+}
+"@.Trim() | Out-File -Encoding ASCII ProtobuildVersion.cs

Build/GenerateVersion.sh

@@ -0,0 +1,43 @@
+#!/bin/bash
+
+# Read the semantic version out of ModuleInfo.xml .... :O
+SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+rdom () { local IFS=\> ; read -d \< E C ;}
+SEMANTIC_VERSION=$(while rdom; do
+    if [[ $E = "SemanticVersion" ]]; then
+        echo $C
+        exit
+    fi
+done < $SCRIPT_DIR/Module.xml)
+
+# Get build date
+BUILD_DATE=`date -u '+%Y-%m-%d %H:%M:%S'`
+BUILD_DATE="$BUILD_DATE UTC"
+
+# Get current commit
+BUILD_COMMIT=`git rev-parse HEAD`
+if [ "$GIT_BRANCH" != "" ]; then
+  BUILD_COMMIT="$BUILD_COMMIT; $GIT_BRANCH"
+fi 
+
+# Determine if there are pending changes (dirty working directory)
+BUILD_IS_DIRTY="false"
+if [ "$(git status --porcelain)" != "" ]; then
+  BUILD_IS_DIRTY="true"
+fi
+
+cat >ProtobuildVersion.cs <<EOF
+namespace Protobuild
+{
+    public static class ProtobuildVersion
+    {
+        public const string SemanticVersion = "$SEMANTIC_VERSION";
+
+        public const string BuildDate = "$BUILD_DATE";
+
+        public const string BuildCommit = "$BUILD_COMMIT";
+
+        public const bool BuiltWithPendingChanges = $BUILD_IS_DIRTY;
+    }
+}
+EOF

Build/Module.xml

@@ -2,6 +2,7 @@
 <Module>
   <Name>Protobuild</Name>
   <Authors>.NET Foundation</Authors>
+  <SemanticVersion>1.17.400</SemanticVersion>
   <Description>Protobuild is a cross-platform project generator for C#.</Description>
   <ProjectUrl>https://protobuild.org/</ProjectUrl>
   <LicenseUrl>https://opensource.org/licenses/MIT</LicenseUrl>

Build/Projects/Protobuild.Internal.definition

@@ -302,6 +302,7 @@
     <Compile Include="ProjectReader\DefinitionSynchroniser.cs" />
     <Compile Include="ProjectReader\XmlElementUtility.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
+    <Compile Include="ProtobuildVersion.cs" />
     <Compile Include="RedirectableConsole.cs" />
     <Compile Include="RetryableWebClient.cs" />
     <Compile Include="SafeToDictionaryExtension.cs" />

Protobuild.Internal/CommandLine/AddPackageCommand.cs

@@ -59,6 +59,16 @@ public int Execute(Execution execution)
             return 0;
         }
 
+        public string GetShortCategory()
+        {
+            return "Package management";
+        }
+
+        public string GetShortDescription()
+        {
+            return "add a package to the module without downloading or installing it";
+        }
+
         public string GetDescription()
         {
             return @"
@@ -71,6 +81,11 @@ public int GetArgCount()
             return 1;
         }
 
+        public string[] GetShortArgNames()
+        {
+            return new[] { "package" };
+        }
+
         public string[] GetArgNames()
         {
             return new[] { "package_url" };

Protobuild.Internal/CommandLine/AutomatedBuildCommand.cs

@@ -34,6 +34,16 @@ public int Execute(Execution execution)
             return _automatedBuildController.Execute(execution.WorkingDirectory, scriptPath);
         }
 
+        public string GetShortCategory()
+        {
+            return "Build automation";
+        }
+
+        public string GetShortDescription()
+        {
+            return "execute the script using Protobuild's automated build scripting language (default automated.build)";
+        }
+
         public string GetDescription()
         {
             return @"
@@ -48,6 +58,11 @@ public int GetArgCount()
             return 1;
         }
 
+        public string[] GetShortArgNames()
+        {
+            return GetArgNames();
+        }
+
         public string[] GetArgNames()
         {
             return new[] {"script_path?"};

Protobuild.Internal/CommandLine/BuildCommand.cs

@@ -328,6 +328,16 @@ where File.Exists(msbuild)
             return 0;
         }
 
+        public string GetShortCategory()
+        {
+            return "Build automation";
+        }
+
+        public string GetShortDescription()
+        {
+            return "builds the module (does not generate it first)";
+        }
+
         public string GetDescription()
         {
             return @"
@@ -341,6 +351,11 @@ public int GetArgCount()
             return 1;
         }
 
+        public string[] GetShortArgNames()
+        {
+            return GetArgNames();
+        }
+
         public string[] GetArgNames()
         {
             return new[] { "platform?" };

Protobuild.Internal/CommandLine/BuildProcessArchCommand.cs

@@ -20,6 +20,16 @@ public int Execute(Execution execution)
             throw new NotSupportedException();
         }
 
+        public string GetShortCategory()
+        {
+            return "Build automation";
+        }
+
+        public string GetShortDescription()
+        {
+            return "set the architecture of MSBuild to use (x86, x64 or Default)";
+        }
+
         public string GetDescription()
         {
             return @"
@@ -38,6 +48,11 @@ public int GetArgCount()
             return 1;
         }
 
+        public string[] GetShortArgNames()
+        {
+            return GetArgNames();
+        }
+
         public string[] GetArgNames()
         {
             return new[] { "arch" };

Protobuild.Internal/CommandLine/BuildPropertyCommand.cs

@@ -20,6 +20,16 @@ public int Execute(Execution execution)
             throw new NotSupportedException();
         }
 
+        public string GetShortCategory()
+        {
+            return "Build automation";
+        }
+
+        public string GetShortDescription()
+        {
+            return "add or set a build property";
+        }
+
         public string GetDescription()
         {
             return @"
@@ -32,6 +42,11 @@ public int GetArgCount()
             return 2;
         }
 
+        public string[] GetShortArgNames()
+        {
+            return GetArgNames();
+        }
+
         public string[] GetArgNames()
         {
             return new[] { "name", "value?" };

Protobuild.Internal/CommandLine/BuildTargetCommand.cs

@@ -20,6 +20,16 @@ public int Execute(Execution execution)
             throw new NotSupportedException();
         }
 
+        public string GetShortCategory()
+        {
+            return "Build automation";
+        }
+
+        public string GetShortDescription()
+        {
+            return "set the build target (defaults to Build)";
+        }
+
         public string GetDescription()
         {
             return @"
@@ -32,6 +42,11 @@ public int GetArgCount()
             return 1;
         }
 
+        public string[] GetShortArgNames()
+        {
+            return new[] { "target" };
+        }
+
         public string[] GetArgNames()
         {
             return new[] { "build_target" };

Protobuild.Internal/CommandLine/CleanCommand.cs

@@ -48,6 +48,16 @@ public int Execute(Execution execution)
             return 1;
         }
 
+        public string GetShortCategory()
+        {
+            return "Project generation";
+        }
+
+        public string GetShortDescription()
+        {
+            return "remove all generated solution and project files";
+        }
+
         public string GetDescription()
         {
             return @"
@@ -61,6 +71,11 @@ public int GetArgCount()
             return 1;
         }
 
+        public string[] GetShortArgNames()
+        {
+            return GetArgNames();
+        }
+
         public string[] GetArgNames()
         {
             return new[] { "platform?" };

Protobuild.Internal/CommandLine/DebugProjectGenerationCommand.cs

@@ -14,6 +14,16 @@ public int Execute(Execution execution)
             throw new NotSupportedException();
         }
 
+        public string GetShortCategory()
+        {
+            return "Internal use";
+        }
+
+        public string GetShortDescription()
+        {
+            return "emit generated intermediate files for debugging";
+        }
+
         public string GetDescription()
         {
             return @"
@@ -27,6 +37,11 @@ public int GetArgCount()
             return 0;
         }
 
+        public string[] GetShortArgNames()
+        {
+            return GetArgNames();
+        }
+
         public string[] GetArgNames()
         {
             return new string[0];

Protobuild.Internal/CommandLine/DebugServiceResolutionCommand.cs

@@ -14,6 +14,16 @@ public int Execute(Execution execution)
             throw new NotSupportedException();
         }
 
+        public string GetShortCategory()
+        {
+            return "Internal use";
+        }
+
+        public string GetShortDescription()
+        {
+            return "enable verbose output for service resolution";
+        }
+
         public string GetDescription()
         {
             return @"
@@ -27,6 +37,11 @@ public int GetArgCount()
             return 0;
         }
 
+        public string[] GetShortArgNames()
+        {
+            return GetArgNames();
+        }
+
         public string[] GetArgNames()
         {
             return new string[0];