Merge branch 'release/1.0.0'

candoumbe · candoumbe · commit 65174b357d0a · 2025-08-27T16:37:33.000+02:00
diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json
@@ -9,7 +9,7 @@
       ]
     },
     "gitversion.tool": {
-      "version": "6.2.0",
+      "version": "6.4.0",
       "commands": [
         "dotnet-gitversion"
       ]
diff --git a/.github/workflows/delivery.yml b/.github/workflows/delivery.yml
@@ -32,7 +32,7 @@ jobs:
     name: ubuntu-latest
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           fetch-depth: 0
       - name: 'Cache: .nuke/temp, ~/.nuget/packages'
diff --git a/.github/workflows/integration.yml b/.github/workflows/integration.yml
@@ -32,7 +32,7 @@ jobs:
     name: ubuntu-latest
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           fetch-depth: 0
       - name: 'Cache: .nuke/temp, ~/.nuget/packages'
diff --git a/.nuke/build.schema.json b/.nuke/build.schema.json
@@ -173,9 +173,9 @@
           "type": "string",
           "description": "Name of the branch to create"
         },
-        "NugetApiKey": {
+        "NuGetApiKey": {
           "type": "string",
-          "description": "Token used to interact with Nuget API",
+          "description": "API Key to use for accessing the NuGet repository",
           "default": "Secrets must be entered via 'nuke :secrets [profile]'"
         },
         "SkipConfirmation": {
diff --git a/.nuke/parameters.local.json b/.nuke/parameters.local.json
@@ -1,4 +1,5 @@
 {
-  "GitHubToken": "v1:rDcK7lT0St3/CdfzkxuYhNWZWoGLJhIHC133qAjgkdaPVMcPfo7yr8Rc8oKHEEPssOrAylXXAMfp/u0pVr8p3OTAT0Va2BJBnpGSKZlg2ubSjFD+uIOzAl3JTo8aajjD",
-  "NugetApiKey": "v1:Sb2YkCpSpTtZP7OxoNc+5hQNmvo6/8sppRW+eNMDuBJ3GK2Iy2VpcW+GRjQIGN73"
-}
+  "$schema": "./build.schema.json",
+  "GitHubToken": "v1:r3dNxCHO7M3A8kirsxd3lKDWFxE0tYfmiTF4JfCYeLBSfiwvW2wm4lHEmsVUkueoAsk1HNLnavJHVWtlxTtkJJLZMJGTtnHHRlM0FpnvsrAupxPYRJWZDqgaGNO7+hAq",
+  "NuGetApiKey": "v1:z7RveyZnVbRsGxFwVN2wEWAckFlLM/Vwb7BY9y42qpLD1nVfVbG5Q3ikRFZ9V/9W"
+}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.0.0] / 2025-08-27
+### 🚀 New features
+- Added `Filter` option to specifiy which benchmarks to perform
+- Added `NuGetApiKey` parameter to `IPushNugetPackages` component
+
+### 🛠️ Fixes
+- Fixed `--major` parameter not read from command line when creating a release branch.
+
 ## [0.13.4] / 2025-08-18
 ### 🛠️ Fixes
 - Fixed incorrect rendering of `IDotNetFormat` command line arguments.
@@ -259,13 +267,14 @@ So now `{MutationTestDirectory}/[{framework}]` is now changed to `{MutationTestD
 
 ### 🔧 Fixes
 - Fixed directory path used by `IUnitTest` target to output unit tests results.
-- Fixed argument format used to define reporters used when running mutation tests.
+- Fixed the argument format used to define reporters used when running mutation tests.
 - Fixed `SourceName` not displayed when running `IPublish.Publish` target
 
 ## [0.1.0] / 2022-10-23
 - Initial release
 
-[Unreleased]: https://github.com/candoumbe/Pipelines/compare/0.13.4...HEAD
+[Unreleased]: https://github.com/candoumbe/Pipelines/compare/1.0.0...HEAD
+[1.0.0]: https://github.com/candoumbe/Pipelines/compare/0.13.4...1.0.0
 [0.13.4]: https://github.com/candoumbe/Pipelines/compare/0.13.3...0.13.4
 [0.13.3]: https://github.com/candoumbe/Pipelines/compare/0.13.2...0.13.3
 [0.13.2]: https://github.com/candoumbe/Pipelines/compare/0.13.1...0.13.2
@@ -288,4 +297,4 @@ So now `{MutationTestDirectory}/[{framework}]` is now changed to `{MutationTestD
 [0.4.0]: https://github.com/candoumbe/Pipelines/compare/0.3.0...0.4.0
 [0.3.0]: https://github.com/candoumbe/Pipelines/compare/0.2.0...0.3.0
 [0.2.0]: https://github.com/candoumbe/Pipelines/compare/0.1.0...0.2.0
-[0.1.0]: https://github.com/candoumbe/Pipelines/tree/0.1.0
+[0.1.0]: https://github.com/candoumbe/Pipelines/tree/0.1.0
diff --git a/README.md b/README.md
@@ -30,14 +30,15 @@ is separated from the history of the code base.
 
 ### 2. **Writing a pipeline file of some sort**
 
-Most of the time in YAML, the file that describes the steps required to build a project are providers specific.
+Most of the time in YAML, the file that describes the steps required to build a project is provider specific.
 So even though you can write YAML, knowing how to write an Azure DevOps pipeline does not really help when it comes to writing a pipeline for GitHub Actions.
 
 ## The solution
 
 [Nuke] is a library written by [Matthias Koch] that helps to create builds.
 
-This project offers an opinionated way at writing pipelines by giving a set of components (more on that later) with the following benefits :
+This project offers an opinionated way at writing pipelines by giving a set of components
+(more on that later) with the following benefits :
 
 1. no need to go your code management tool to set up your project CI/CD.
 2. no more YAML file : yeah YAML is great but the tooling is not great and the structure itself is error-prone.
@@ -230,7 +231,7 @@ PRs are welcome, check out the [contribution guidelines] if you want to contribu
 
 - [Matthias Koch] for the marvelous [Nuke] library. This project would never exist without its work.
 
-[Nuke]: https://github.com/nuke/
+[Nuke]: https://github.com/nuke-build/nuke
 [Nuke.GlobalTool]: https://nuget.org/packages/Nuke.GlobalTool
 [Matthias Koch]: https://github.com/matkoch
 [Candoumbe.Pipelines]: https://nuget.org/packages/Candoumbe.Pipelines
@@ -241,4 +242,4 @@ PRs are welcome, check out the [contribution guidelines] if you want to contribu
 [IGitFlow]: ./src/Candoumbe.Pipelines/Components/Workflows/IGitFlow.cs
 [IGitHubFlow]: ./src/Candoumbe.Pipelines/Components/Workflows/IGitHubFlow.cs
 [IGitFlowWithPullRequest]: ./src/Candoumbe.Pipelines/Components/GitHub/IGitFlowWithPullRequest.cs
-[IGitHubFlowWithPullRequest]: ./src/Candoumbe.Pipelines/Components/GitHub/IGitHubFlowWithPullRequest.cs
+[IGitHubFlowWithPullRequest]: ./src/Candoumbe.Pipelines/Components/GitHub/IGitHubFlowWithPullRequest.cs
diff --git a/build/Pipeline.cs b/build/Pipeline.cs
@@ -25,7 +25,7 @@
     EnableGitHubToken = true,
     ImportSecrets =
     [
-        nameof(NugetApiKey)
+        nameof(IPushNugetPackages.NuGetApiKey)
     ],
     PublishArtifacts = true,
     OnPullRequestExcludePaths =
@@ -45,7 +45,7 @@
     EnableGitHubToken = true,
     ImportSecrets =
     [
-        nameof(NugetApiKey)
+        nameof(IPushNugetPackages.NuGetApiKey)
     ],
     PublishArtifacts = true,
     OnPullRequestExcludePaths =
@@ -83,12 +83,6 @@ public class Pipeline : EnhancedNukeBuild,
     ///<inheritdoc/>
     Solution IHaveSolution.Solution => Solution;
 
-    /// <summary>
-    /// Token used to interact with GitHub API
-    /// </summary>
-    [Parameter("Token used to interact with Nuget API")]
-    [Secret]
-    public readonly string NugetApiKey;
 
     /// Support plugins are available for:
     ///   - JetBrains ReSharper        https://nuke.build/resharper
@@ -107,9 +101,9 @@ public class Pipeline : EnhancedNukeBuild,
     IEnumerable<PushNugetPackageConfiguration> IPushNugetPackages.PublishConfigurations =>
     [
         new NugetPushConfiguration(
-            apiKey: NugetApiKey,
+            apiKey: this.As<IPushNugetPackages>()?.NuGetApiKey,
             source: new Uri("https://api.nuget.org/v3/index.json"),
-            canBeUsed: () => NugetApiKey is not null
+            canBeUsed: () => this.As<IPushNugetPackages>()?.NuGetApiKey is not null
         ),
         new GitHubPushNugetConfiguration(
             githubToken: this.Get<ICreateGithubRelease>()?.GitHubToken,
diff --git a/core.props b/core.props
@@ -33,7 +33,7 @@
     </When>
   </Choose>
   <ItemGroup>
-    <PackageReference Include="Roslynator.Analyzers" Version="4.13.1">
+    <PackageReference Include="Roslynator.Analyzers" Version="4.14.0">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
     </PackageReference>
@@ -43,6 +43,6 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Candoumbe.Miscutilities" Version="0.14.0"/>
+    <PackageReference Include="Candoumbe.Miscutilities" Version="0.15.0"/>
   </ItemGroup>
 </Project>
diff --git a/global.json b/global.json
@@ -1,5 +1,5 @@
 {
   "sdk": {
-    "version": "8.0.408"
+    "version": "8.0.413"
   }
 }
diff --git a/src/Candoumbe.Pipelines/Components/IBenchmark.cs b/src/Candoumbe.Pipelines/Components/IBenchmark.cs
@@ -23,6 +23,12 @@ public interface IBenchmark : ICompile, IHaveArtifacts
     /// </summary>
     public IEnumerable<Project> BenchmarkProjects { get; }
 
+    /// <summary>
+    /// Allows to filter benchmarks to run by their full name (namespace.typeName.methodName) using glob pattern.
+    /// </summary>
+    [Parameter("Filter benchmarks to run by their full name (namespace.typeName.methodName) using glob pattern.")]
+    string Filter => TryGetValue(() => Filter) ?? "*";
+
     /// <summary>
     /// Runs performance tests using <see href="https://benchmarkdotnet.org">BenchmarkDotNet</see>
     /// </summary>
@@ -49,7 +55,9 @@ public interface IBenchmark : ICompile, IHaveArtifacts
     /// </summary>
     public sealed Configure<DotNetRunSettings> BenchmarksSettingsBase => _ => _
             .SetConfiguration(Configuration.Release)
-            .SetProcessAdditionalArguments("-- --filter *", $"--artifacts {BenchmarkResultDirectory}", "--join");
+            .SetProcessAdditionalArguments($"-- --filter {Filter}",
+                                           $"--artifacts {BenchmarkResultDirectory}",
+                                           "--join");
 
     /// <summary>
     /// Configures the way performance tests are run.
diff --git a/src/Candoumbe.Pipelines/Components/IHaveGitVersion.cs b/src/Candoumbe.Pipelines/Components/IHaveGitVersion.cs
@@ -25,7 +25,7 @@ public interface IHaveGitVersion : INukeBuild, IRequireNuGetPackage
     /// The value of this property is only taken into account when running <see cref="Release"/> target.
     /// </remarks>
     [Parameter("Hint to create a major release.")]
-    bool Major => false;
+    bool Major => TryGetValue<bool?>(() => Major) ?? false;
 
     /// <summary>
     /// Major.Minor.Patch Version number
diff --git a/src/Candoumbe.Pipelines/Components/IMutationTest.cs b/src/Candoumbe.Pipelines/Components/IMutationTest.cs
@@ -122,7 +122,7 @@ void RunMutationTestsForTheProject(MutationProjectConfiguration mutationProject,
                             {
                                 case { } branchName when string.Equals(branchName, IHaveDevelopBranch.DevelopBranchName, StringComparison.InvariantCultureIgnoreCase):
                                     {
-                                        // we are in git flow, so we can compare develop with main branch
+                                        // we are in git flow, so we can compare the develop branch with the main branch
                                         strykerArgs = strykerArgs.SetWithBaseline(IHaveMainBranch.MainBranchName);
                                     }
                                     break;
diff --git a/src/Candoumbe.Pipelines/Components/NuGet/IPushNugetPackages.cs b/src/Candoumbe.Pipelines/Components/NuGet/IPushNugetPackages.cs
@@ -22,6 +22,13 @@ namespace Candoumbe.Pipelines.Components.NuGet;
 /// </remarks>
 public interface IPushNugetPackages : IPack
 {
+    /// <summary>
+    /// API Key to use for accessing the NuGet repository.
+    /// </summary>
+    [Parameter("API Key to use for accessing the NuGet repository.")]
+    [Secret]
+    string NuGetApiKey => TryGetValue(() => NuGetApiKey);
+
     /// <summary>
     /// Defines which files should be pushed when calling <see cref="Publish"/> target
     /// </summary>
@@ -131,4 +138,4 @@ public interface IPushNugetPackages : IPack
     /// Determines where <see cref="Publish"/> will push packages
     /// </summary>
     IEnumerable<PushNugetPackageConfiguration> PublishConfigurations { get; }
-}
+}
diff --git a/src/Candoumbe.Pipelines/tools/.editorconfig b/src/Candoumbe.Pipelines/tools/.editorconfig
@@ -0,0 +1,2 @@
+[*.cs]
+dotnet_diagnostic.CS1591.severity = none
diff --git a/src/Candoumbe.Pipelines/tools/Stryker/Stryker.Generated.cs b/src/Candoumbe.Pipelines/tools/Stryker/Stryker.Generated.cs
@@ -46,7 +46,7 @@ public partial class StrykerSettings : ToolOptions
     [Argument(Format = "--config-file {value}")] public string ConfigFile => Get<string>(() => ConfigFile);
     /// <summary>The solution path can be supplied to help with dependency resolution. If stryker is ran from the solution file location the solution file will be analyzed and all projects in the solution will be tested by stryker.</summary>
     [Argument(Format = "--solution {value}")] public Nuke.Common.IO.AbsolutePath Solution => Get<Nuke.Common.IO.AbsolutePath>(() => Solution);
-    /// <summary>The project file name is required when your test project has more than one project reference. Stryker can currently mutate one project under test for 1..N test projects but not 1..N projects under test for one test project.<br /><i>Do not pass a path to this option. Pass the project file <b>name</strong> as it appears in your test project's references</i></summary>
+    /// <summary>The project file name is required when your test project has more than one project reference. Stryker can currently mutate one project under test for 1..N test projects but not 1..N projects under test for one test project.<br /><i>Do not pass a path to this option. Pass the project file <b>name</b> as it appears in your test project's references</i></summary>
     [Argument(Format = "--project {value}")] public string Project => Get<string>(() => Project);
     /// <summary>When you have multiple test projects covering one project under test you may specify all relevant test projects in the config file. You must run stryker from the project under test instead of the test project directory when using multiple test projects.</summary>
     [Argument(Format = "--test-project {value}")] public IReadOnlyList<string> TestProjects => Get<List<string>>(() => TestProjects);
diff --git a/src/Candoumbe.Pipelines/tools/Stryker/Stryker.json b/src/Candoumbe.Pipelines/tools/Stryker/Stryker.json
@@ -31,7 +31,7 @@
             "name": "Project",
             "type": "string",
             "format": "--project {value}",
-            "help": "The project file name is required when your test project has more than one project reference. Stryker can currently mutate one project under test for 1..N test projects but not 1..N projects under test for one test project.<br /><i>Do not pass a path to this option. Pass the project file <b>name</strong> as it appears in your test project's references</i>"
+            "help": "The project file name is required when your test project has more than one project reference. Stryker can currently mutate one project under test for 1..N test projects but not 1..N projects under test for one test project.<br /><i>Do not pass a path to this option. Pass the project file <b>name</b> as it appears in your test project's references</i>"
           },
           {
             "name": "TestProjects",

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`	`]`
`10`	`10`	`},`
`11`	`11`	`"gitversion.tool": {`
`12`		`- "version": "6.2.0",`
	`12`	`+ "version": "6.4.0",`
`13`	`13`	`"commands": [`
`14`	`14`	`"dotnet-gitversion"`
`15`	`15`	`]`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`{`
`2`		`- "GitHubToken": "v1:rDcK7lT0St3/CdfzkxuYhNWZWoGLJhIHC133qAjgkdaPVMcPfo7yr8Rc8oKHEEPssOrAylXXAMfp/u0pVr8p3OTAT0Va2BJBnpGSKZlg2ubSjFD+uIOzAl3JTo8aajjD",`
`3`		`- "NugetApiKey": "v1:Sb2YkCpSpTtZP7OxoNc+5hQNmvo6/8sppRW+eNMDuBJ3GK2Iy2VpcW+GRjQIGN73"`
`4`		`-}`
	`2`	`+ "$schema": "./build.schema.json",`
	`3`	`+ "GitHubToken": "v1:r3dNxCHO7M3A8kirsxd3lKDWFxE0tYfmiTF4JfCYeLBSfiwvW2wm4lHEmsVUkueoAsk1HNLnavJHVWtlxTtkJJLZMJGTtnHHRlM0FpnvsrAupxPYRJWZDqgaGNO7+hAq",`
	`4`	`+ "NuGetApiKey": "v1:z7RveyZnVbRsGxFwVN2wEWAckFlLM/Vwb7BY9y42qpLD1nVfVbG5Q3ikRFZ9V/9W"`
	`5`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`	`2`	`"sdk": {`
`3`		`- "version": "8.0.408"`
	`3`	`+ "version": "8.0.413"`
`4`	`4`	`}`
`5`	`5`	`}`