vNext

.github/workflows/Build.yml

@@ -16,6 +16,10 @@ jobs:
 
   SetupBuildInfo:
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write
+      pull-requests: write
     outputs:
       build-name: ${{ steps.SetupBuildInfo.outputs.build-name }}
       build-id: ${{ steps.SetupBuildInfo.outputs.build-id }}
@@ -34,6 +38,8 @@ jobs:
       - name: SetupBuildInfo
         id: SetupBuildInfo
         run: dotnet run --project _atom/_atom.csproj SetupBuildInfo --skip --headless
+        env:
+          pull-request-number: ${{ github.event.number }}
 
   PackProjects:
     runs-on: ubuntu-latest
@@ -291,7 +297,7 @@ jobs:
   PushToRelease:
     needs: [ PackProjects, PackTool, TestProjects, SetupBuildInfo ]
     runs-on: ubuntu-latest
-    if: contains(needs.SetupBuildInfo.outputs.build-version, '-') == false
+    if: !contains(needs.SetupBuildInfo.outputs.build-version, '-')
     permissions:
       contents: write
     steps:

.github/workflows/Validate.yml

@@ -11,6 +11,10 @@ jobs:
 
   SetupBuildInfo:
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write
+      pull-requests: write
     outputs:
       build-name: ${{ steps.SetupBuildInfo.outputs.build-name }}
       build-id: ${{ steps.SetupBuildInfo.outputs.build-id }}
@@ -29,6 +33,8 @@ jobs:
       - name: SetupBuildInfo
         id: SetupBuildInfo
         run: dotnet run --project _atom/_atom.csproj SetupBuildInfo --skip --headless
+        env:
+          pull-request-number: ${{ github.event.number }}
 
   PackProjects:
     runs-on: ubuntu-latest
@@ -133,3 +139,33 @@ jobs:
         with:
           name: DecSm.Atom.Tool.Tests-${{ matrix.job-runs-on }}-${{ matrix.test-framework }}
           path: "${{ github.workspace }}/.github/publish/DecSm.Atom.Tool.Tests"
+
+  CheckPrForBreakingChanges:
+    needs: [ SetupBuildInfo ]
+    runs-on: ubuntu-latest
+    permissions:
+      checks: write
+      contents: write
+      id-token: write
+      pull-requests: write
+    steps:
+
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: '10.0.x'
+
+      - name: CheckPrForBreakingChanges
+        id: CheckPrForBreakingChanges
+        run: dotnet run --project _atom/_atom.csproj CheckPrForBreakingChanges --skip --headless
+        env:
+          build-version: ${{ needs.SetupBuildInfo.outputs.build-version }}
+          azure-vault-app-secret: ${{ secrets.AZURE_VAULT_APP_SECRET }}
+          azure-vault-address: ${{ vars.AZURE_VAULT_ADDRESS }}
+          azure-vault-tenant-id: ${{ vars.AZURE_VAULT_TENANT_ID }}
+          azure-vault-app-id: ${{ vars.AZURE_VAULT_APP_ID }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          pull-request-number: ${{ github.event.number }}

DecSm.Atom.Module.AzureKeyVault/AzureKeySecretsProvider.cs

@@ -1,4 +1,6 @@
-namespace DecSm.Atom.Module.AzureKeyVault;
+using DecSm.Atom.Workflows.Options;
+
+namespace DecSm.Atom.Module.AzureKeyVault;
 
 /// <summary>
 ///     Provides an implementation of <see cref="ISecretsProvider" /> and <see cref="IWorkflowOptionProvider" />
@@ -83,12 +85,14 @@ public IReadOnlyList<IWorkflowOption> WorkflowOptions
             {
                 case AzureKeyVaultValueInjectionType.EnvironmentVariable:
                     valueInjections.Add(
-                        WorkflowSecretsEnvironmentInjection.Create(nameof(IAzureKeyVault.AzureVaultAddress)));
+                        Workflows.Definition.Options.WorkflowOptions.Inject.SecretFromWorkflowEnvironment(
+                            nameof(IAzureKeyVault.AzureVaultAddress)));
 
                     break;
                 case AzureKeyVaultValueInjectionType.Secret:
                     valueInjections.Add(
-                        WorkflowSecretsSecretInjection.Create(nameof(IAzureKeyVault.AzureVaultAddress)));
+                        Workflows.Definition.Options.WorkflowOptions.Inject.SecretForSecretProvider(
+                            nameof(IAzureKeyVault.AzureVaultAddress)));
 
                     break;
                 case AzureKeyVaultValueInjectionType.None:
@@ -103,12 +107,14 @@ public IReadOnlyList<IWorkflowOption> WorkflowOptions
             {
                 case AzureKeyVaultValueInjectionType.EnvironmentVariable:
                     valueInjections.Add(
-                        WorkflowSecretsEnvironmentInjection.Create(nameof(IAzureKeyVault.AzureVaultTenantId)));
+                        Workflows.Definition.Options.WorkflowOptions.Inject.SecretFromWorkflowEnvironment(
+                            nameof(IAzureKeyVault.AzureVaultTenantId)));
 
                     break;
                 case AzureKeyVaultValueInjectionType.Secret:
                     valueInjections.Add(
-                        WorkflowSecretsSecretInjection.Create(nameof(IAzureKeyVault.AzureVaultTenantId)));
+                        Workflows.Definition.Options.WorkflowOptions.Inject.SecretForSecretProvider(
+                            nameof(IAzureKeyVault.AzureVaultTenantId)));
 
                     break;
                 case AzureKeyVaultValueInjectionType.None:
@@ -123,11 +129,14 @@ public IReadOnlyList<IWorkflowOption> WorkflowOptions
             {
                 case AzureKeyVaultValueInjectionType.EnvironmentVariable:
                     valueInjections.Add(
-                        WorkflowSecretsEnvironmentInjection.Create(nameof(IAzureKeyVault.AzureVaultAppId)));
+                        Workflows.Definition.Options.WorkflowOptions.Inject.SecretFromWorkflowEnvironment(
+                            nameof(IAzureKeyVault.AzureVaultAppId)));
 
                     break;
                 case AzureKeyVaultValueInjectionType.Secret:
-                    valueInjections.Add(WorkflowSecretsSecretInjection.Create(nameof(IAzureKeyVault.AzureVaultAppId)));
+                    valueInjections.Add(
+                        Workflows.Definition.Options.WorkflowOptions.Inject.SecretForSecretProvider(
+                            nameof(IAzureKeyVault.AzureVaultAppId)));
 
                     break;
                 case AzureKeyVaultValueInjectionType.None:
@@ -142,12 +151,14 @@ public IReadOnlyList<IWorkflowOption> WorkflowOptions
             {
                 case AzureKeyVaultValueInjectionType.EnvironmentVariable:
                     valueInjections.Add(
-                        WorkflowSecretsEnvironmentInjection.Create(nameof(IAzureKeyVault.AzureVaultAppSecret)));
+                        Workflows.Definition.Options.WorkflowOptions.Inject.SecretFromWorkflowEnvironment(
+                            nameof(IAzureKeyVault.AzureVaultAppSecret)));
 
                     break;
                 case AzureKeyVaultValueInjectionType.Secret:
                     valueInjections.Add(
-                        WorkflowSecretsSecretInjection.Create(nameof(IAzureKeyVault.AzureVaultAppSecret)));
+                        Workflows.Definition.Options.WorkflowOptions.Inject.SecretForSecretProvider(
+                            nameof(IAzureKeyVault.AzureVaultAppSecret)));
 
                     break;
                 case AzureKeyVaultValueInjectionType.None:

DecSm.Atom.Module.AzureKeyVault/WorkflowOptionsExtensions.cs

@@ -0,0 +1,30 @@
+namespace DecSm.Atom.Module.AzureKeyVault;
+
+[PublicAPI]
+[SuppressMessage("Performance", "CA1822:Mark members as static")]
+public static class WorkflowOptionsExtensions
+{
+    [PublicAPI]
+    public class Options
+    {
+        internal static Options Instance { get; } = new();
+
+        public UseAzureKeyVault Use =>
+            new()
+            {
+                Value = true,
+            };
+
+        public UseAzureKeyVault DoNotUse =>
+            new()
+            {
+                Value = false,
+            };
+    }
+
+    extension(WorkflowOptions)
+    {
+        [PublicAPI]
+        public static Options AzureKeyVault => Options.Instance;
+    }
+}

DecSm.Atom.Module.AzureKeyVault/_usings.cs

@@ -1,4 +1,5 @@
-global using Azure.Core;
+global using System.Diagnostics.CodeAnalysis;
+global using Azure.Core;
 global using Azure.Identity;
 global using Azure.Security.KeyVault.Secrets;
 global using DecSm.Atom.Args;

DecSm.Atom.Module.AzureStorage/AzureBlobArtifactProvider.cs

@@ -209,7 +209,7 @@ public async Task RetrieveArtifacts(
                 {
                     Prefix = artifactBlobDir,
                 },
-                cancellationToken: cancellationToken);
+                cancellationToken);
 
             await foreach (var blobItem in blobs)
             {
@@ -272,7 +272,7 @@ public async Task Cleanup(IReadOnlyList<string> runIdentifiers, CancellationToke
                 {
                     Prefix = $"{buildName}/{buildIdPath}/",
                 },
-                cancellationToken: cancellationToken);
+                cancellationToken);
 
             await foreach (var blob in blobs)
             {
@@ -324,7 +324,7 @@ public async Task<IReadOnlyList<string>> GetStoredRunIdentifiers(
             {
                 Prefix = $"{buildName}/",
             },
-            cancellationToken: cancellationToken);
+            cancellationToken);
 
         var buildIds = new List<string>();
 

DecSm.Atom.Module.DevopsWorkflows.Tests/Workflows/ArtifactBuild.cs

@@ -69,7 +69,7 @@ public partial class CustomArtifactBuild : MinimalBuildDefinition,
                     }),
             ],
             WorkflowTypes = [Devops.WorkflowType],
-            Options = [UseCustomArtifactProvider.Enabled],
+            Options = [WorkflowOptions.Artifacts.UseCustomProvider],
         },
     ];
 }

DecSm.Atom.Module.DevopsWorkflows.Tests/Workflows/CheckoutOptionBuild.cs

@@ -7,11 +7,11 @@ public partial class CheckoutOptionBuild : MinimalBuildDefinition, IDevopsWorkfl
     [
         new("checkoutoption-workflow")
         {
-            Triggers = [ManualTrigger.Empty],
+            Triggers = [WorkflowTriggers.Manual],
             Targets =
             [
                 WorkflowTargets.CheckoutOptionTarget.WithOptions(
-                    DevopsCheckoutOption.Create(new(true, "recursive"))),
+                    WorkflowOptions.Devops.ConfigureCheckout(true, "recursive")),
             ],
             WorkflowTypes = [Devops.WorkflowType],
         },

DecSm.Atom.Module.DevopsWorkflows.Tests/Workflows/DuplicateDependencyBuild.cs

@@ -3,13 +3,16 @@
 [BuildDefinition]
 public partial class DuplicateDependencyBuild : MinimalBuildDefinition, IDevopsWorkflows, IDuplicateDependencyTarget
 {
-    public override IReadOnlyList<IWorkflowOption> GlobalWorkflowOptions => [UseCustomArtifactProvider.Enabled];
+    public override IReadOnlyList<IWorkflowOption> GlobalWorkflowOptions =>
+    [
+        WorkflowOptions.Artifacts.UseCustomProvider,
+    ];
 
     public override IReadOnlyList<WorkflowDefinition> Workflows =>
     [
         new("duplicatedependency-workflow")
         {
-            Triggers = [ManualTrigger.Empty],
+            Triggers = [WorkflowTriggers.Manual],
             Targets = [WorkflowTargets.DuplicateDependencyTarget1],
             WorkflowTypes = [Devops.WorkflowType],
         },

DecSm.Atom.Module.DevopsWorkflows.Tests/Workflows/EnvironmentBuild.cs

@@ -7,8 +7,11 @@ public partial class EnvironmentBuild : MinimalBuildDefinition, IDevopsWorkflows
     [
         new("environment-workflow")
         {
-            Triggers = [ManualTrigger.Empty],
-            Targets = [WorkflowTargets.EnvironmentTarget.WithOptions(DeployToEnvironment.Create("test-env-1"))],
+            Triggers = [WorkflowTriggers.Manual],
+            Targets =
+            [
+                WorkflowTargets.EnvironmentTarget.WithOptions(WorkflowOptions.Deploy.ToEnvironment("test-env-1")),
+            ],
             WorkflowTypes = [Devops.WorkflowType],
         },
     ];

DecSm.Atom.Module.DevopsWorkflows.Tests/Workflows/ManualInputBuild.cs

@@ -13,13 +13,13 @@ public partial class ManualInputBuild : MinimalBuildDefinition, IDevopsWorkflows
                 {
                     Inputs =
                     [
-                        ManualStringInput.ForParam(ParamDefinitions[Params.StringParamWithoutDefault]),
-                        ManualStringInput.ForParam(ParamDefinitions[Params.StringParamWithDefault]),
-                        ManualBoolInput.ForParam(ParamDefinitions[Params.BoolParamWithoutDefault]),
-                        ManualBoolInput.ForParam(ParamDefinitions[Params.BoolParamWithDefault]),
-                        ManualChoiceInput.ForParam(ParamDefinitions[Params.ChoiceParamWithoutDefault],
+                        ManualStringInput.ForParam(ParamDefinitions[WorkflowParams.StringParamWithoutDefault]),
+                        ManualStringInput.ForParam(ParamDefinitions[WorkflowParams.StringParamWithDefault]),
+                        ManualBoolInput.ForParam(ParamDefinitions[WorkflowParams.BoolParamWithoutDefault]),
+                        ManualBoolInput.ForParam(ParamDefinitions[WorkflowParams.BoolParamWithDefault]),
+                        ManualChoiceInput.ForParam(ParamDefinitions[WorkflowParams.ChoiceParamWithoutDefault],
                             ["choice 1", "choice 2", "choice 3"]),
-                        ManualChoiceInput.ForParam(ParamDefinitions[Params.ChoiceParamWithDefault],
+                        ManualChoiceInput.ForParam(ParamDefinitions[WorkflowParams.ChoiceParamWithDefault],
                             ["choice 1", "choice 2", "choice 3"]),
                     ],
                 },

DecSm.Atom.Module.DevopsWorkflows.Tests/Workflows/SetupDotnetBuild.cs

@@ -7,7 +7,7 @@ public partial class SetupDotnetBuild : MinimalBuildDefinition, IDevopsWorkflows
     [
         new("setup-dotnet")
         {
-            Triggers = [GitPushTrigger.ToMain],
+            Triggers = [WorkflowTriggers.PushToMain],
             Targets = [WorkflowTargets.SetupDotnetTarget.WithOptions(new SetupDotnetStep("9.0.x"))],
             WorkflowTypes = [Devops.WorkflowType],
         },

DecSm.Atom.Module.DevopsWorkflows/Extensions.cs

@@ -7,24 +7,24 @@
 [PublicAPI]
 public static class Extensions
 {
-    /// <summary>
-    ///     Configures the workflow target to run on a matrix of Azure DevOps agent pool labels.
-    /// </summary>
-    /// <param name="workflowTargetDefinition">The workflow target definition to extend.</param>
-    /// <param name="labels">An array of agent pool labels (e.g., "ubuntu-latest", "windows-latest").</param>
-    /// <returns>The modified <see cref="WorkflowTargetDefinition" /> for chaining.</returns>
-    /// <remarks>
-    ///     This method sets up a matrix dimension for the `JobRunsOn` parameter, allowing the job
-    ///     to execute on multiple agent pool environments. It also adds the <see cref="DevopsPool.SetByMatrix" />
-    ///     option to indicate that the agent pool is determined by the matrix.
-    /// </remarks>
-    public static WorkflowTargetDefinition WithDevopsPoolMatrix(
-        this WorkflowTargetDefinition workflowTargetDefinition,
-        string[] labels) =>
-        workflowTargetDefinition
-            .WithMatrixDimensions(new MatrixDimension(nameof(IJobRunsOn.JobRunsOn))
-            {
-                Values = labels,
-            })
-            .WithOptions(DevopsPool.SetByMatrix);
+    extension(WorkflowTargetDefinition workflowTargetDefinition)
+    {
+        /// <summary>
+        ///     Configures the workflow target to run on a matrix of Azure DevOps agent pool labels.
+        /// </summary>
+        /// <param name="labels">An array of agent pool labels (e.g., "ubuntu-latest", "windows-latest").</param>
+        /// <returns>The modified <see cref="WorkflowTargetDefinition" /> for chaining.</returns>
+        /// <remarks>
+        ///     This method sets up a matrix dimension for the `JobRunsOn` parameter, allowing the job
+        ///     to execute on multiple agent pool environments. It also adds the SetByMatrix options ( "$(job-runs-on)" )
+        ///     option to indicate that the agent pool is determined by the matrix.
+        /// </remarks>
+        public WorkflowTargetDefinition WithDevopsPoolMatrix(string[] labels) =>
+            workflowTargetDefinition
+                .WithMatrixDimensions(new MatrixDimension(nameof(IJobRunsOn.JobRunsOn))
+                {
+                    Values = labels,
+                })
+                .WithOptions(WorkflowOptions.Devops.DevopsPool.SetByMatrix);
+    }
 }