Generate json schemas for the configuration and output files

.github/actions/artifacts-restore/action.yml

@@ -18,12 +18,6 @@ runs:
     with:
       path: tools
       key: tools-${{ runner.os }}-${{ hashFiles('./build/**') }}
-  -
-    uses: actions/download-artifact@v3
-    name: Download gitversion tool
-    with:
-      name: tool
-      path: ${{ github.workspace }}/dogfood
   -
     name: Setup .NET SDK
     uses: actions/setup-dotnet@v3

.github/workflows/_prepare.yml

@@ -21,22 +21,22 @@ jobs:
       with:
         path: run
         key: run-${{ runner.os }}-${{ hashFiles('./build/**') }}
+    - name: Use cached tools
+      id: cache-tools
+      uses: actions/cache@v3
+      with:
+        path: tools
+        key: tools-${{ runner.os }}-${{ hashFiles('./build/**') }}
     -
       name: Setup .NET SDK
       uses: actions/setup-dotnet@v3
       with:
         global-json-file: global.json
     -
-      name: '[Prepare]'
+      name: '[Build]'
       if: steps.cache-cake.outputs.cache-hit != 'true'
       run: dotnet build build/CI.sln --configuration=Release
     -
-      name: '[DogFood]'
+      name: '[Prepare]'
       shell: pwsh
       run: dotnet run/build.dll --target=BuildPrepare
-    -
-      name: 'Upload gitversion tool'
-      uses: actions/upload-artifact@v3
-      with:
-        name: tool
-        path: ${{ github.workspace }}/dogfood

.github/workflows/docs.yml

@@ -80,19 +80,14 @@ jobs:
       with:
         global-json-file: global.json
     -
-      name: '[Prepare]'
+      name: '[Build]'
       if: steps.cache-cake.outputs.cache-hit != 'true'
       run: dotnet build build/CI.sln --configuration=Release
     -
-      name: '[DogFood]'
+      name: '[Prepare]'
       shell: pwsh
       run: dotnet run/build.dll --target=BuildPrepare
-    -
-      name: 'Upload gitversion tool'
-      uses: actions/upload-artifact@v3
-      with:
-        name: tool
-        path: ${{ github.workspace }}/dogfood
+
   validate:
     name: Validates Html
     needs: [prepare]
@@ -145,6 +140,11 @@ jobs:
     -
       name: Restore State
       uses: ./.github/actions/artifacts-restore
+    -
+      name: '[Build Schemas]'
+      shell: pwsh
+      run: |
+        dotnet run/docs.dll --target=GenerateSchemas
     -
       name: '[Publish Documentation]'
       if: ${{ github.event_name == 'push' }}

build/.run/GenerateSchemas.run.xml

@@ -0,0 +1,20 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="GenerateSchemas" type="DotNetProject" factoryName=".NET Project" folderName="Docs">
+    <option name="EXE_PATH" value="$PROJECT_DIR$/../run/docs.exe" />
+    <option name="PROGRAM_PARAMETERS" value="--target=GenerateSchemas" />
+    <option name="WORKING_DIRECTORY" value="$PROJECT_DIR$/.." />
+    <option name="PASS_PARENT_ENVS" value="1" />
+    <option name="USE_EXTERNAL_CONSOLE" value="0" />
+    <option name="USE_MONO" value="0" />
+    <option name="RUNTIME_ARGUMENTS" value="" />
+    <option name="PROJECT_PATH" value="$PROJECT_DIR$/docs/docs.csproj" />
+    <option name="PROJECT_EXE_PATH_TRACKING" value="1" />
+    <option name="PROJECT_ARGUMENTS_TRACKING" value="1" />
+    <option name="PROJECT_WORKING_DIRECTORY_TRACKING" value="0" />
+    <option name="PROJECT_KIND" value="DotNetCore" />
+    <option name="PROJECT_TFM" value="net7.0" />
+    <method v="2">
+      <option name="Build" />
+    </method>
+  </configuration>
+</component>

build/CI.sln

@@ -22,6 +22,32 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "docs", "docs\docs.csproj",
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "release", "release\release.csproj", "{8DAB65D8-57E8-4185-96FC-8A7C7373FC23}"
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "workflows", "workflows", "{8E5B758F-925A-49E4-9011-20AD2A9E1F43}"
+	ProjectSection(SolutionItems) = preProject
+		..\.github\workflows\ci.yml = ..\.github\workflows\ci.yml
+		..\.github\workflows\codeql-analysis.yml = ..\.github\workflows\codeql-analysis.yml
+		..\.github\workflows\docs.yml = ..\.github\workflows\docs.yml
+		..\.github\workflows\format.yml = ..\.github\workflows\format.yml
+		..\.github\workflows\homebrew.yml = ..\.github\workflows\homebrew.yml
+		..\.github\workflows\release.yml = ..\.github\workflows\release.yml
+		..\.github\workflows\_artifacts_linux.yml = ..\.github\workflows\_artifacts_linux.yml
+		..\.github\workflows\_artifacts_windows.yml = ..\.github\workflows\_artifacts_windows.yml
+		..\.github\workflows\_build.yml = ..\.github\workflows\_build.yml
+		..\.github\workflows\_docker.yml = ..\.github\workflows\_docker.yml
+		..\.github\workflows\_docker_manifests.yml = ..\.github\workflows\_docker_manifests.yml
+		..\.github\workflows\_prepare.yml = ..\.github\workflows\_prepare.yml
+		..\.github\workflows\_publish.yml = ..\.github\workflows\_publish.yml
+		..\.github\workflows\_unit_tests.yml = ..\.github\workflows\_unit_tests.yml
+	EndProjectSection
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "actions", "actions", "{A9B92261-AB9C-47D6-A8A7-616A5A62B063}"
+	ProjectSection(SolutionItems) = preProject
+		..\.github\actions\artifacts-restore\action.yml = ..\.github\actions\artifacts-restore\action.yml
+		..\.github\actions\docker-manifests\action.yml = ..\.github\actions\docker-manifests\action.yml
+		..\.github\actions\docker-publish\action.yml = ..\.github\actions\docker-publish\action.yml
+		..\.github\actions\docker-test\action.yml = ..\.github\actions\docker-test\action.yml
+	EndProjectSection
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU

build/build/Tasks/BuildPrepare.cs

@@ -12,20 +12,29 @@ public override void Run(BuildContext context)
         context.Information("Builds solution...");
 
         const string sln = "./src/GitVersion.sln";
-        const string project = "./src/GitVersion.App/GitVersion.App.csproj";
         context.DotNetRestore(sln,
             new()
             {
                 Verbosity = DotNetVerbosity.Minimal,
                 Sources = new[] { Constants.NugetOrgUrl },
             });
 
-        context.DotNetBuild(project,
+        context.DotNetBuild("./src/GitVersion.App/GitVersion.App.csproj",
             new()
             {
                 Verbosity = DotNetVerbosity.Minimal,
                 Configuration = Constants.DefaultConfiguration,
-                OutputDirectory = Paths.Dogfood,
+                OutputDirectory = Paths.Tools.Combine("gitversion"),
+                Framework = Constants.NetVersionLatest,
+                NoRestore = true,
+            });
+
+        context.DotNetBuild("./src/GitVersion.Schema/GitVersion.Schema.csproj",
+            new()
+            {
+                Verbosity = DotNetVerbosity.Minimal,
+                Configuration = Constants.DefaultConfiguration,
+                OutputDirectory = Paths.Tools.Combine("schema"),
                 Framework = Constants.NetVersionLatest,
                 NoRestore = true,
             });

build/common/Lifetime/BuildLifetimeBase.cs

@@ -29,7 +29,7 @@ public override void Setup(T context, ISetupContext info)
             context.Information("Running BuildPrepare...");
             return;
         }
-        var gitversionTool = context.GetDogFoodGitVersionToolLocation();
+        var gitversionTool = context.GetGitVersionDotnetToolLocation();
         var gitVersionSettings = new GitVersionSettings
         {
             OutputTypes = new HashSet<GitVersionOutput> { GitVersionOutput.Json, GitVersionOutput.BuildServer },

build/common/Utilities/ContextExtensions.cs

@@ -166,6 +166,8 @@ public static string GetBranchName(this ICakeContext context)
 
     public static FilePath? GetGitVersionToolLocation(this ICakeContext context) =>
         context.GetFiles($"src/GitVersion.App/bin/{Constants.DefaultConfiguration}/{Constants.NetVersionLatest}/gitversion.dll").SingleOrDefault();
-    public static FilePath? GetDogFoodGitVersionToolLocation(this ICakeContext context) =>
-        context.MakeAbsolute(Paths.Dogfood.CombineWithFilePath("gitversion.dll"));
+    public static FilePath? GetGitVersionDotnetToolLocation(this ICakeContext context) =>
+        context.MakeAbsolute(Paths.Tools.Combine("gitversion").CombineWithFilePath("gitversion.dll"));
+    public static FilePath? GetSchemaDotnetToolLocation(this ICakeContext context) =>
+        context.MakeAbsolute(Paths.Tools.Combine("schema").CombineWithFilePath("schema.dll"));
 }

build/common/Utilities/Paths.cs

@@ -8,17 +8,15 @@ public class Paths
     public static readonly DirectoryPath Src = Root.Combine("src");
     public static readonly DirectoryPath Docs = Root.Combine("docs");
     public static readonly DirectoryPath Build = Root.Combine("build");
-    public static readonly DirectoryPath Dogfood = Root.Combine("dogfood");
+    public static readonly DirectoryPath Schemas = Root.Combine("schemas");
+    public static readonly DirectoryPath Tools = Root.Combine("tools");
     public static readonly DirectoryPath Integration = Root.Combine("tests").Combine("integration");
 
-    public static readonly DirectoryPath Nuspec = Build.Combine("nuspec");
-
     public static readonly DirectoryPath TestOutput = Artifacts.Combine("test-results");
     public static readonly DirectoryPath Packages = Artifacts.Combine("packages");
     public static readonly DirectoryPath ArtifactsDocs = Artifacts.Combine("docs");
 
     public static readonly DirectoryPath Native = Packages.Combine("native");
     public static readonly DirectoryPath Nuget = Packages.Combine("nuget");
-    public static readonly DirectoryPath ArtifactsBinCmdline = Packages.Combine("prepare").Combine("cmdline");
     public static readonly DirectoryPath ArtifactsBinPortable = Packages.Combine("prepare").Combine("portable");
 }

build/docs/Tasks/GenerateSchemas.cs

@@ -0,0 +1,21 @@
+using Common.Utilities;
+
+namespace Docs.Tasks;
+
+[TaskName(nameof(GenerateSchemas))]
+[TaskDescription("Generate schemas")]
+public sealed class GenerateSchemas : FrostingTask<BuildContext>
+{
+    public override void Run(BuildContext context)
+    {
+        var schemaTool = context.GetSchemaDotnetToolLocation();
+        var gitVersion = context.Version!.GitVersion;
+        var version = $"{gitVersion.Major}.{gitVersion.Minor}";
+        var schemaTargetDir = context.MakeAbsolute(Paths.Root.Combine("schemas"));
+        context.EnsureDirectoryExists(schemaTargetDir);
+        context.Information("Schema tool: {0}", schemaTool);
+        context.Information("Schema target dir: {0}", schemaTargetDir);
+        context.Information("Schema version: {0}", version);
+        context.DotNetExecute(schemaTool, $"--Version {version} --OutputDirectory {schemaTargetDir}");
+    }
+}

build/docs/Tasks/PreviewDocs.cs

@@ -20,8 +20,13 @@ public override void Run(BuildContext context)
     {
         if (context.WyamSettings is not null)
         {
+            var schemaTargetDir = Paths.ArtifactsDocs.Combine("preview").Combine("schemas");
+            context.EnsureDirectoryExists(schemaTargetDir);
+            context.CopyDirectory(Paths.Schemas, schemaTargetDir);
+
             context.WyamSettings.Preview = true;
             context.WyamSettings.Watch = true;
+            context.WyamSettings.NoClean = true;
             context.WyamSettings.Settings.Add("Host", "gittools.github.io");
             context.Wyam(context.WyamSettings);
         }

build/docs/Tasks/PublishDocs.cs

@@ -82,6 +82,10 @@ private static void PublishDocumentation(BuildContext context)
             context.Wyam(context.WyamSettings);
         }
 
+        var schemaTargetDir = publishFolder.Combine("schemas");
+        context.EnsureDirectoryExists(schemaTargetDir);
+        context.CopyDirectory(Paths.Schemas, schemaTargetDir);
+
         if (!context.GitHasUncommitedChanges(publishFolder)) return;
 
         context.Information("Stage all changes...");

docs/input/_Bottom.cshtml

@@ -1,9 +1,10 @@
 <div class="github-button">
     <a href="https://github.com/GitTools/GitVersion"><i class="fa fa-github"></i> GitHub</a>
 </div>
-<script>
+@* disable gitter sidecar - https://github.com/matrix-org/matrix-public-archive/issues/157 *@
+@* <script>
     ((window.gitter = {}).chat = {}).options = {
         room: 'GitTools/GitVersion'
     };
 </script>
-<script src="https://sidecar.gitter.im/dist/sidecar.v1.js" async defer></script>
+<script src="https://sidecar.gitter.im/dist/sidecar.v1.js" async defer></script> *@