Merge branch 'main' into refactor-next-version-calculator

GitTools · Nov 23, 2022 · 0977561 · 0977561
2 parents 059375f + d056ec8
commit 0977561
Show file tree

Hide file tree

Showing 64 changed files with 430 additions and 218 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -56,10 +56,9 @@ jobs:
         key: run-${{ runner.os }}-${{ hashFiles('./build/**') }}
     -
       name: Setup .NET SDK
-      uses: actions/[email protected].2
+      uses: actions/[email protected].3
       with:
         dotnet-version: '7.0.x'
-        dotnet-quality: 'preview'
     -
       name: '[Prepare]'
       if: steps.cache-cake.outputs.cache-hit != 'true'
@@ -96,10 +95,9 @@ jobs:
         key: tools-${{ runner.os }}-${{ hashFiles('./build/**') }}
     -
       name: Setup .NET SDK
-      uses: actions/[email protected].2
+      uses: actions/[email protected].3
       with:
         dotnet-version: '7.0.x'
-        dotnet-quality: 'preview'
     -
       name: '[Build]'
       shell: pwsh
@@ -160,10 +158,9 @@ jobs:
         key: tools-${{ runner.os }}-${{ hashFiles('./build/**') }}
     -
       name: Setup .NET SDK
-      uses: actions/[email protected].2
+      uses: actions/[email protected].3
       with:
         dotnet-version: '7.0.x'
-        dotnet-quality: 'preview'
     -
       name: '[Unit Test]'
       shell: pwsh
@@ -213,10 +210,9 @@ jobs:
         path: ${{ github.workspace }}/artifacts/packages/nuget
     -
       name: Setup .NET SDK
-      uses: actions/[email protected].2
+      uses: actions/[email protected].3
       with:
         dotnet-version: '7.0.x'
-        dotnet-quality: 'preview'
     -
       name: '[Test Artifacts]'
       shell: pwsh
@@ -274,10 +270,9 @@ jobs:
         install: true
     -
       name: Setup .NET SDK
-      uses: actions/[email protected].2
+      uses: actions/[email protected].3
       with:
         dotnet-version: '7.0.x'
-        dotnet-quality: 'preview'
     -
       name: '[Test Artifacts (amd64)]'
       shell: pwsh
@@ -333,10 +328,9 @@ jobs:
         install: true
     -
       name: Setup .NET SDK
-      uses: actions/[email protected].2
+      uses: actions/[email protected].3
       with:
         dotnet-version: '7.0.x'
-        dotnet-quality: 'preview'
     -
       name: Login to DockerHub
       if: success() && github.event_name != 'pull_request' && github.repository_owner == 'GitTools'
@@ -424,10 +418,9 @@ jobs:
         path: ${{ github.workspace }}/artifacts/packages/nuget
     -
       name: Setup .NET SDK
-      uses: actions/[email protected].2
+      uses: actions/[email protected].3
       with:
         dotnet-version: '7.0.x'
-        dotnet-quality: 'preview'
     -
       name: '[Publish]'
       shell: pwsh
@@ -479,10 +472,9 @@ jobs:
         path: ${{ github.workspace }}/artifacts/packages/native
     -
       name: Setup .NET SDK
-      uses: actions/[email protected].2
+      uses: actions/[email protected].3
       with:
         dotnet-version: '7.0.x'
-        dotnet-quality: 'preview'
     -
       name: '[Release]'
       shell: pwsh

diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -59,10 +59,9 @@ jobs:
 
     -
       name: Setup .NET SDK
-      uses: actions/[email protected].2
+      uses: actions/[email protected].3
       with:
         dotnet-version: '7.0.x'
-        dotnet-quality: 'preview'
 
     -
       name: '[Prepare]'

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -58,8 +58,11 @@ jobs:
         key: tools-${{ runner.os }}-${{ hashFiles('./build/**') }}
     -
       name: Get npm cache directory
+      shell: bash
       id: cache-node-dir
-      run: echo "::set-output name=dir::$(npm config get cache)"
+      run: |
+        cacheDir=$(npm config get cache)
+        echo "dir=$cacheDir" >> $GITHUB_OUTPUT
     -
       name: Cache Node Modules
       id: cache-node
@@ -70,10 +73,9 @@ jobs:
         restore-keys: node-${{ runner.os }}
     -
       name: Setup .NET SDK
-      uses: actions/[email protected].2
+      uses: actions/[email protected].3
       with:
         dotnet-version: '7.0.x'
-        dotnet-quality: 'preview'
     -
       name: '[Prepare]'
       if: steps.cache-cake.outputs.cache-hit != 'true'
@@ -105,10 +107,9 @@ jobs:
         key: tools-${{ runner.os }}-${{ hashFiles('./build/**') }}
     -
       name: Setup .NET SDK
-      uses: actions/[email protected].2
+      uses: actions/[email protected].3
       with:
         dotnet-version: '7.0.x'
-        dotnet-quality: 'preview'
     -
       name: '[Build Documentation]'
       shell: pwsh
@@ -118,15 +119,13 @@ jobs:
       uses: chabad360/htmlproofer@master
       with:
         directory: ./artifacts/docs/preview
-        arguments: --url-ignore /api/ --allow-hash-href --assume-extension --disable-external
+        arguments: --ignore-urls /api/,/docs/ --allow-hash-href --assume-extension --disable-external
     -
-      name: Reviewdog Reporter
-      uses: haya14busa/action-cond@v1
+      name: '[Reviewdog Reporter]'
       id: reporter
-      with:
-        cond: ${{ github.event_name == 'pull_request' }}
-        if_true: github-pr-review
-        if_false: github-check
+      run: |
+        value=$([ ${{ github.event_name == 'pull_request' }} ] && echo "github-pr-review" || echo "github-check")
+        echo "value=$value" >> $GITHUB_OUTPUT
     -
       name: '[Remark Lint]'
       uses: reviewdog/[email protected]
@@ -163,10 +162,9 @@ jobs:
         key: tools-${{ runner.os }}-${{ hashFiles('./build/**') }}
     -
       name: Setup .NET SDK
-      uses: actions/[email protected].2
+      uses: actions/[email protected].3
       with:
         dotnet-version: '7.0.x'
-        dotnet-quality: 'preview'
     -
       name: '[Publish Documentation]'
       if: ${{ github.event_name == 'push' }}

diff --git a/.github/workflows/format.yml b/.github/workflows/format.yml
@@ -30,10 +30,9 @@ jobs:
       - uses: actions/checkout@v3
       -
         name: Setup .NET SDK
-        uses: actions/[email protected].2
+        uses: actions/[email protected].3
         with:
           dotnet-version: '7.0.x'
-          dotnet-quality: 'preview'
       -
         name: Run Format Build solution
         run: dotnet format ./build/ --verify-no-changes

diff --git a/.remarkrc.yaml b/.remarkrc.yaml
@@ -25,12 +25,12 @@ plugins:
   - remark-lint-no-blockquote-without-marker
   - remark-lint-no-consecutive-blank-lines
   - remark-lint-no-duplicate-definitions
-  - remark-lint-no-duplicate-headings
+  - remark-lint-no-duplicate-headings: ["warn"]
   - remark-lint-no-emphasis-as-heading
   - remark-lint-no-empty-url
   - remark-lint-no-file-name-articles
   - remark-lint-no-file-name-consecutive-dashes
-  - remark-lint-no-file-name-irregular-characters
+  - remark-lint-no-file-name-irregular-characters: ["warn"]
   - remark-lint-no-file-name-mixed-case
   - remark-lint-no-file-name-outer-dashes
   - remark-lint-no-heading-content-indent

diff --git a/README.md b/README.md
@@ -14,7 +14,7 @@ works out the [Semantic Version][semver] of the commit being built.
 | **GitVersion.Portable**    |                     [![Chocolatey][choco-badge]][choco]            |
 | **GitVersion.Tool**        |                           [![NuGet][gvgt-badge]][gvgt]             |
 | **GitVersion.CommandLine** |                           [![NuGet][gvcl-badge]][gvcl]             |
-| **GitVersion.MsBuild**     |                            [![NuGet][gvt-badge]][gvt]              | Known as [GitVersionTask] before v5.6.0 |
+| **GitVersion.MsBuild**     |                            [![NuGet][gvt-badge]][gvt]              | Known as [GitVersionTask][gitversiontask] before v5.6.0 |
 | **Homebrew**               |                        [![homebrew][brew-badge]][brew]             |
 | **Azure Pipeline Task**    | [![Azure Pipeline Task][az-pipeline-task-badge]][az-pipeline-task] |
 | **Github Action**          |             [![Github Action][gh-actions-badge]][gh-actions]       |

diff --git a/SECURITY.md b/SECURITY.md
@@ -17,13 +17,13 @@ You should receive a response within 24 hours. If for some reason you do not, pl
 
 Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
 
-  * Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
-  * Full paths of source file(s) related to the manifestation of the issue
-  * The location of the affected source code (tag/branch/commit or direct URL)
-  * Any special configuration required to reproduce the issue
-  * Step-by-step instructions to reproduce the issue
-  * Proof-of-concept or exploit code (if possible)
-  * Impact of the issue, including how an attacker might exploit the issue
+*   Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
+*   Full paths of source file(s) related to the manifestation of the issue
+*   The location of the affected source code (tag/branch/commit or direct URL)
+*   Any special configuration required to reproduce the issue
+*   Step-by-step instructions to reproduce the issue
+*   Proof-of-concept or exploit code (if possible)
+*   Impact of the issue, including how an attacker might exploit the issue
 
 This information will help us triage your report more quickly.
 

diff --git a/build/Directory.Build.props b/build/Directory.Build.props
@@ -38,7 +38,6 @@
         <Using Include="Common.Utilities.Constants" Alias="Constants"/>
     </ItemGroup>
     <ItemGroup>
-        <PackageReference Include="Cake.Common" />
         <PackageReference Include="Cake.Compression" />
         <PackageReference Include="Cake.Frosting" />
         <PackageReference Include="Cake.Incubator" />

diff --git a/build/Directory.Packages.props b/build/Directory.Packages.props
@@ -3,11 +3,10 @@
         <ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>
     </PropertyGroup>
     <ItemGroup>
-        <PackageVersion Include="Cake.Common" Version="2.3.0" />
         <PackageVersion Include="Cake.Compression" Version="0.3.0" />
         <PackageVersion Include="Cake.Codecov" Version="1.0.1" />
         <PackageVersion Include="Cake.Coverlet" Version="2.5.4" />
-        <PackageVersion Include="Cake.Frosting" Version="2.3.0" />
+        <PackageVersion Include="Cake.Frosting" Version="3.0.0" />
         <PackageVersion Include="Cake.Incubator" Version="7.0.0" />
         <PackageVersion Include="Cake.DotNetLocalTools.Module" Version="1.0.2" />
         <PackageVersion Include="Cake.Docker" Version="1.1.2" />

diff --git a/build/artifacts/BuildLifetime.cs b/build/artifacts/BuildLifetime.cs
@@ -4,9 +4,9 @@ namespace Artifacts;
 
 public class BuildLifetime : BuildLifetimeBase<BuildContext>
 {
-    public override void Setup(BuildContext context)
+    public override void Setup(BuildContext context, ISetupContext info)
     {
-        base.Setup(context);
+        base.Setup(context, info);
 
         context.IsDockerOnLinux = context.DockerCustomCommand("info --format '{{.OSType}}'").First().Replace("'", string.Empty) == "linux";
 

diff --git a/build/build/BuildLifetime.cs b/build/build/BuildLifetime.cs
@@ -5,9 +5,9 @@ namespace Build;
 
 public class BuildLifetime : BuildLifetimeBase<BuildContext>
 {
-    public override void Setup(BuildContext context)
+    public override void Setup(BuildContext context, ISetupContext info)
     {
-        base.Setup(context);
+        base.Setup(context, info);
 
         context.MsBuildConfiguration = context.Argument(Arguments.Configuration, "Release");
         context.EnabledUnitTests = context.IsEnabled(EnvVars.EnabledUnitTests);

diff --git a/build/build/Tasks/Test/UnitTest.cs b/build/build/Tasks/Test/UnitTest.cs
@@ -3,6 +3,7 @@
 using Cake.Coverlet;
 using Cake.Incubator.LoggingExtensions;
 using Common.Utilities;
+using CoverletSettings = Common.Addins.Cake.Coverlet.CoverletSettings;
 
 namespace Build.Tasks;
 

diff --git a/build/chores/BuildLifetime.cs b/build/chores/BuildLifetime.cs
@@ -4,7 +4,7 @@ namespace Chores;
 
 public class BuildLifetime : FrostingLifetime<BuildContext>
 {
-    public override void Setup(BuildContext context)
+    public override void Setup(BuildContext context, ISetupContext info)
     {
         context.StartGroup("Build Setup");
         context.EndGroup();

diff --git a/build/common/Addins/Cake.Coverlet/ArgumentsProcessor.cs b/build/common/Addins/Cake.Coverlet/ArgumentsProcessor.cs
@@ -4,13 +4,13 @@ namespace Common.Addins.Cake.Coverlet;
 
 internal static class ArgumentsProcessor
 {
-    public static ProcessArgumentBuilder ProcessMSBuildArguments(
+    public static ProcessArgumentBuilder ProcessMsBuildArguments(
         CoverletSettings settings,
         ICakeEnvironment cakeEnvironment,
         ProcessArgumentBuilder builder,
         FilePath project)
     {
-        builder.AppendMSBuildProperty(nameof(CoverletSettings.CollectCoverage), settings.CollectCoverage.ToString());
+        builder.AppendMsBuildProperty(nameof(CoverletSettings.CollectCoverage), settings.CollectCoverage.ToString());
         builder.AppendPropertyList(nameof(CoverletSettings.CoverletOutputFormat), SplitFlagEnum(settings.CoverletOutputFormat));
 
         if (settings.Threshold.HasValue)
@@ -20,7 +20,7 @@ public static ProcessArgumentBuilder ProcessMSBuildArguments(
                 throw new Exception("Threshold Percentage cannot be set as greater than 100%");
             }
 
-            builder.AppendMSBuildProperty(nameof(CoverletSettings.Threshold), settings.Threshold.ToString()!);
+            builder.AppendMsBuildProperty(nameof(CoverletSettings.Threshold), settings.Threshold.ToString()!);
 
             if (settings.ThresholdType != ThresholdType.NotSet)
             {
@@ -33,7 +33,7 @@ public static ProcessArgumentBuilder ProcessMSBuildArguments(
             var directoryPath = settings.CoverletOutputDirectory
                 .MakeAbsolute(cakeEnvironment).FullPath;
 
-            builder.AppendMSBuildPropertyQuoted("CoverletOutput", directoryPath);
+            builder.AppendMsBuildPropertyQuoted("CoverletOutput", directoryPath);
         }
         else if (!string.IsNullOrEmpty(settings.CoverletOutputName))
         {
@@ -42,7 +42,7 @@ public static ProcessArgumentBuilder ProcessMSBuildArguments(
 
             var filepath = FilePath.FromString(settings.OutputTransformer(settings.CoverletOutputName, directoryPath));
 
-            builder.AppendMSBuildPropertyQuoted("CoverletOutput", filepath.MakeAbsolute(cakeEnvironment).FullPath);
+            builder.AppendMsBuildPropertyQuoted("CoverletOutput", filepath.MakeAbsolute(cakeEnvironment).FullPath);
         }
 
         if (settings.ExcludeByFile.Count > 0)
@@ -69,12 +69,12 @@ public static ProcessArgumentBuilder ProcessMSBuildArguments(
 
         if (settings.MergeWithFile != null && settings.MergeWithFile.GetExtension() == ".json")
         {
-            builder.AppendMSBuildPropertyQuoted("MergeWith", settings.MergeWithFile.MakeAbsolute(cakeEnvironment).FullPath);
+            builder.AppendMsBuildPropertyQuoted("MergeWith", settings.MergeWithFile.MakeAbsolute(cakeEnvironment).FullPath);
         }
 
         if (settings.IncludeTestAssembly.HasValue)
         {
-            builder.AppendMSBuildProperty(nameof(CoverletSettings.IncludeTestAssembly), settings.IncludeTestAssembly.Value ? bool.TrueString : bool.FalseString);
+            builder.AppendMsBuildProperty(nameof(CoverletSettings.IncludeTestAssembly), settings.IncludeTestAssembly.Value ? bool.TrueString : bool.FalseString);
         }
 
         return builder;

diff --git a/build/common/Addins/Cake.Coverlet/BuilderExtension.cs b/build/common/Addins/Cake.Coverlet/BuilderExtension.cs
@@ -2,13 +2,13 @@ namespace Common.Addins.Cake.Coverlet;
 
 internal static class BuilderExtension
 {
-    internal static ProcessArgumentBuilder AppendMSBuildProperty(this ProcessArgumentBuilder builder, string propertyName, string value)
+    internal static ProcessArgumentBuilder AppendMsBuildProperty(this ProcessArgumentBuilder builder, string propertyName, string value)
     {
         builder.AppendSwitch($"/property:{propertyName}", "=", value);
         return builder;
     }
 
-    internal static ProcessArgumentBuilder AppendMSBuildPropertyQuoted(this ProcessArgumentBuilder builder, string propertyName, string value)
+    internal static ProcessArgumentBuilder AppendMsBuildPropertyQuoted(this ProcessArgumentBuilder builder, string propertyName, string value)
     {
         builder.AppendSwitchQuoted($"/property:{propertyName}", "=", value);
         return builder;