Merge pull request #296 from Lombiq/issue/OSOE-743

OSOE-743: Cancel ongoing runs of long-running workflows under a PR when new changes are pushed, vol.2

.github/workflows/build-and-test-dotnet.yml

@@ -10,8 +10,22 @@ on:
           are used.
 
     inputs:
+      cancel-in-progress-for-this-pr:
+        description: >
+          When set to "true", it will cancel the already running workflow for this pull request. See the concurrency
+          settings of the job for more details.
+        type: string
+        default: 'true'
+      parent-job-name:
+        description: >
+          An optional technical identifier that is used to construct the concurrency key to be able to distinguish
+          different jobs in the same parent workflow calling this one. This is necessary if you build multiple solutions
+          (as separate jobs) in the same workflow for these jobs not to conflict with each other.
+        type: string
+        default: 'parent-job'
+        required: false
       cancel-workflow-on-failure:
-        description: When set to "true", will cancel the current workflow run with all jobs if this workflow fails.
+        description: When set to "true", it will cancel the current workflow run with all jobs if this workflow fails.
         type: string
         default: 'true'
       # This needs to be stringified JSON because inputs don't support arrays, see
@@ -59,14 +73,14 @@ on:
         default: 'false'
         description: >
           If set to "true", the NuGet packages will be cached by GitHub. This is faster if you have a lot of NuGet
-          packages, but negligible or even slower if you only have a handful. When run on BuildJet, will use the
+          packages, but negligible or even slower if you only have a handful. When run on BuildJet, it will use the
           BuildJet cache instead of GitHub's, which is faster.
       build-enable-npm-caching:
         type: string
         default: 'false'
         description: >
           If set to "true", the NPM packages will be cached by GitHub. This is faster if you have a lot of NPM packages,
-          packages, but negligible or even slower if you only have a handful. When run on BuildJet, will use the
+          packages, but negligible or even slower if you only have a handful. When run on BuildJet, it will use the
           BuildJet cache instead of GitHub's, which is faster.
       build-cache-version:
         type: string
@@ -115,7 +129,7 @@ on:
       dotnet-consolidation-exclude-version-regex:
         type: string
         required: false
-        default: "-alpha"
+        default: '-alpha'
         description: >
           A regular expression to match package versions that will be skipped during NuGet package consolidation.
       warnings-as-errors:
@@ -135,9 +149,27 @@ jobs:
     runs-on: ${{ matrix.machine-type }}
     name: Build and Test
     strategy:
+      # The parameters added to the strategy matrix should also be used to construct the concurrency key.
       matrix:
         machine-type: ${{ fromJson(inputs.machine-types) }}
     timeout-minutes: ${{ inputs.timeout-minutes }}
+    concurrency:
+      # If "cancel-in-progress-for-this-pr" is set to "true" and this run is for a pull request, then the concurrency
+      # key will be constructed from a handful of parameters to produce a value that would evaluate to the same value on
+      # a subsequent push (while still allowing different solutions to be built with the same configuration), causing
+      # the already running job (with the same strategy) for this pull request to be cancelled. Otherwise it will be the
+      # ID of the workflow run combined with the strategy parameters, making it more unique so that parallel runs of
+      # this job aren't kept waiting. This workflow's technical name is also included in both cases, so that it doesn't
+      # conflict with other jobs calling a different workflow that are started by the same caller workflow. The caller
+      # job's technical name is optionally included in the concurrency key, so that different jobs in the same parent
+      # workflow calling this one don't conflict with each other.
+      group: |
+        ${{
+          inputs.cancel-in-progress-for-this-pr == 'true' && github.event_name == 'pull_request'
+            && format('{0}_build-and-test-dotnet_{1}_{2}_{3}', github.workflow, inputs.parent-job-name, matrix.machine-type, github.ref)
+            || format('{0}_build-and-test-dotnet_{1}_{2}', github.run_id, inputs.parent-job-name, matrix.machine-type)
+        }}
+      cancel-in-progress: ${{ inputs.cancel-in-progress-for-this-pr == 'true' }}
     steps:
       - name: Checkout
         uses: Lombiq/GitHub-Actions/.github/actions/checkout@dev

.github/workflows/build-and-test-orchard-core.yml

@@ -10,8 +10,22 @@ on:
           are used.
 
     inputs:
+      cancel-in-progress-for-this-pr:
+        description: >
+          When set to "true", it will cancel the already running workflow for this pull request. See the concurrency
+          settings of the job for more details.
+        type: string
+        default: 'true'
+      parent-job-name:
+        description: >
+          An optional technical identifier that is used to construct the concurrency key to be able to distinguish
+          different jobs in the same parent workflow calling this one. This is necessary if you build multiple solutions
+          (as separate jobs) in the same workflow for these jobs not to conflict with each other.
+        type: string
+        default: 'parent-job'
+        required: false
       cancel-workflow-on-failure:
-        description: If "true", will cancel the current workflow run with all jobs if this workflow fails.
+        description: When set to "true", it will cancel the current workflow run with all jobs if this workflow fails.
         type: string
         default: 'true'
       # This needs to be stringified JSON, because inputs don't support arrays, see
@@ -142,7 +156,7 @@ on:
       dotnet-consolidation-exclude-version-regex:
         type: string
         required: false
-        default: "-alpha"
+        default: '-alpha'
         description: >
           A regular expression to match package versions that will be skipped during NuGet package consolidation.
       warnings-as-errors:
@@ -158,9 +172,27 @@ jobs:
     runs-on: ${{ matrix.machine-type }}
     name: Build and Test
     strategy:
+      # The parameters added to the strategy matrix should also be used to construct the concurrency key.
       matrix:
         machine-type: ${{ fromJson(inputs.machine-types) }}
     timeout-minutes: ${{ inputs.timeout-minutes }}
+    concurrency:
+      # If "cancel-in-progress-for-this-pr" is set to "true" and this run is for a pull request, then the concurrency
+      # key will be constructed from a handful of parameters to produce a value that would evaluate to the same value on
+      # a subsequent push (while still allowing different solutions to be built with the same configuration), causing
+      # the already running job (with the same strategy) for this pull request to be cancelled. Otherwise it will be the
+      # ID of the workflow run combined with the strategy parameters, making it more unique so that parallel runs of
+      # this job aren't kept waiting. This workflow's technical name is also included in both cases, so that it doesn't
+      # conflict with other jobs calling a different workflow that are started by the same caller workflow. The caller
+      # job's technical name is optionally included in the concurrency key, so that different jobs in the same parent
+      # workflow calling this one don't conflict with each other.
+      group: |
+        ${{
+          inputs.cancel-in-progress-for-this-pr == 'true' && github.event_name == 'pull_request'
+            && format('{0}_build-and-test-orchard-core_{1}_{2}_{3}', github.workflow, inputs.parent-job-name, matrix.machine-type, github.ref)
+            || format('{0}_build-and-test-orchard-core_{1}_{2}', github.run_id, inputs.parent-job-name, matrix.machine-type)
+        }}
+      cancel-in-progress: ${{ inputs.cancel-in-progress-for-this-pr == 'true' }}
     steps:
       - name: Checkout
         uses: Lombiq/GitHub-Actions/.github/actions/checkout@dev

.github/workflows/build-dotnet.yml

@@ -12,7 +12,7 @@ on:
 
     inputs:
       cancel-workflow-on-failure:
-        description: When set to "true", will cancel the current workflow run with all jobs if this workflow fails.
+        description: When set to "true", it will cancel the current workflow run with all jobs if this workflow fails.
         type: string
         default: 'true'
       # This needs to be stringified JSON because inputs don't support arrays, see
@@ -44,7 +44,7 @@ on:
         default: 'false'
         description: >
           If set to "true", the NuGet packages will be cached by GitHub. This is faster if you have a lot of NuGet
-          packages, but negligible or even slower if you only have a handful. When run on BuildJet, will use the
+          packages, but negligible or even slower if you only have a handful. When run on BuildJet, it will use the
           BuildJet cache instead of GitHub's, which is faster.
       build-enable-npm-caching:
         type: string

.github/workflows/deploy-orchard1-to-azure-app-service.yml

@@ -44,7 +44,7 @@ on:
 
     inputs:
       cancel-workflow-on-failure:
-        description: When set to "true", will cancel the current workflow run with all jobs if this workflow fails.
+        description: When set to "true", it will cancel the current workflow run with all jobs if this workflow fails.
         type: string
         default: 'false'
       timeout-minutes:

.github/workflows/deploy-to-azure-app-service.yml

@@ -41,7 +41,7 @@ on:
 
     inputs:
       cancel-workflow-on-failure:
-        description: When set to "true", will cancel the current workflow run with all jobs if this workflow fails.
+        description: When set to "true", it will cancel the current workflow run with all jobs if this workflow fails.
         type: string
         default: 'false'
       machine-type:
@@ -69,14 +69,14 @@ on:
         default: 'false'
         description: >
           If set to "true", the NuGet packages will be cached by GitHub. This is faster if you have a lot of NuGet
-          packages, but negligible or even slower if you only have a handful. When run on BuildJet, will use the
+          packages, but negligible or even slower if you only have a handful. When run on BuildJet, it will use the
           BuildJet cache instead of GitHub's, which is faster.
       build-enable-npm-caching:
         type: string
         default: 'false'
         description: >
           If set to "true", the NPM packages will be cached by GitHub. This is faster if you have a lot of NPM packages,
-          packages, but negligible or even slower if you only have a handful. When run on BuildJet, will use the
+          packages, but negligible or even slower if you only have a handful. When run on BuildJet, it will use the
           BuildJet cache instead of GitHub's, which is faster.
       build-cache-version:
         type: string

.github/workflows/msbuild-and-test.yml

@@ -1,5 +1,23 @@
 name: Build and Test .NET Solution with MSBuild
 
+concurrency:
+  # If "cancel-in-progress-for-this-pr" is set to "true" and this run is for a pull request, then the concurrency
+  # key will be constructed from a handful of parameters to produce a value that would evaluate to the same value on
+  # a subsequent push (while still allowing different solutions to be built with the same configuration), causing
+  # the already running job (with the same strategy) for this pull request to be cancelled. Otherwise it will be the
+  # ID of the workflow run combined with the strategy parameters, making it more unique so that parallel runs of
+  # this job aren't kept waiting. This workflow's technical name is also included in both cases, so that it doesn't
+  # conflict with other jobs calling a different workflow that are started by the same caller workflow. The caller
+  # job's technical name is optionally included in the concurrency key, so that different jobs in the same parent
+  # workflow calling this one don't conflict with each other.
+  group: |
+    ${{
+      inputs.cancel-in-progress-for-this-pr == 'true' && github.event_name == 'pull_request'
+        && format('{0}_msbuild-and-test_{1}_{2}_{3}', github.workflow, inputs.parent-job-name, inputs.machine-type, github.ref)
+        || format('{0}_msbuild-and-test_{1}_{2}', github.run_id, inputs.parent-job-name, inputs.machine-type)
+    }}
+  cancel-in-progress: ${{ inputs.cancel-in-progress-for-this-pr == 'true' }}
+
 on:
   workflow_call:
     secrets:
@@ -10,8 +28,22 @@ on:
           are used.
 
     inputs:
+      cancel-in-progress-for-this-pr:
+        description: >
+          When set to "true", it will cancel the already running workflow for this pull request. See the concurrency
+          settings of the workflow above for more details.
+        type: string
+        default: 'true'
+      parent-job-name:
+        description: >
+          An optional technical identifier that is used to construct the concurrency key to be able to distinguish
+          different jobs in the same parent workflow calling this one. This is necessary if you build multiple solutions
+          (as separate jobs) in the same workflow for these jobs not to conflict with each other.
+        type: string
+        default: 'parent-job'
+        required: false
       cancel-workflow-on-failure:
-        description: When set to "true", will cancel the current workflow run with all jobs if this workflow fails.
+        description: When set to "true", it will cancel the current workflow run with all jobs if this workflow fails.
         type: string
         default: 'true'
       machine-type:
@@ -93,7 +125,7 @@ jobs:
           build-directory: ${{ inputs.build-directory }}
           test-verbosity: ${{ inputs.build-verbosity }}
           test-filter: ${{ inputs.test-filter }}
-          test-configuration: "Release"
+          test-configuration: 'Release'
 
       - name: Cancel Workflow on Failure
         if: failure() && inputs.cancel-workflow-on-failure == 'true'

.github/workflows/publish-nuget.yml

@@ -14,7 +14,7 @@ on:
 
     inputs:
       cancel-workflow-on-failure:
-        description: When set to "true", will cancel the current workflow run with all jobs if this workflow fails.
+        description: When set to "true", it will cancel the current workflow run with all jobs if this workflow fails.
         type: string
         default: 'true'
       source:

.github/workflows/reset-azure-environment.yml

@@ -35,7 +35,7 @@ on:
 
     inputs:
       cancel-workflow-on-failure:
-        description: When set to "true", will cancel the current workflow run with all jobs if this workflow fails.
+        description: When set to "true", it will cancel the current workflow run with all jobs if this workflow fails.
         type: string
         default: 'false'
       machine-type:

.github/workflows/spelling.yml

@@ -1,5 +1,21 @@
 name: Spelling
 
+concurrency:
+  # If "cancel-in-progress-for-this-pr" is set to "true" and this is running for a pull request, then the concurrency
+  # key will be constructed from the name of the workflow and the branch name, causing the already running job in this
+  # workflow for this pull request to be cancelled. Otherwise it will be the ID of the workflow run, making it globally
+  # unique and not cancel anything. Concurrency is defined for the whole workflow, because it has only two jobs
+  # (check-spelling and comment-pr) and the latter depends on the former, so they won't run in parallel. A technical
+  # name for this workflow is also included in both cases, so that it doesn't come into conflict with other jobs calling
+  # a different workflow that are started by the same caller workflow.
+  group: |
+    ${{
+      inputs.cancel-in-progress-for-this-pr == 'true' && github.event_name == 'pull_request'
+        && format('{0}_spell-checking_{1}', github.workflow, github.ref)
+        || format('{0}_spell-checking', github.run_id)
+    }}
+  cancel-in-progress: ${{ inputs.cancel-in-progress-for-this-pr == 'true' }}
+
 on:
   workflow_call:
     secrets:
@@ -11,8 +27,14 @@ on:
 
     # When updating defaults here also update them in the `spelling` action.
     inputs:
+      cancel-in-progress-for-this-pr:
+        description: >
+          When set to "true", it will cancel the already running workflow for this pull request. See the concurrency
+          settings of the workflow above for more details.
+        type: string
+        default: 'true'
       cancel-workflow-on-failure:
-        description: When set to "true", will cancel the current workflow run with all jobs if this workflow fails.
+        description: When set to "true", it will cancel the current workflow run with all jobs if this workflow fails.
         type: string
         default: 'true'
       merge-file-excludes:

.github/workflows/swap-azure-web-app-slots.yml

@@ -32,7 +32,7 @@ on:
 
     inputs:
       cancel-workflow-on-failure:
-        description: When set to "true", will cancel the current workflow run with all jobs if this workflow fails.
+        description: When set to "true", it will cancel the current workflow run with all jobs if this workflow fails.
         type: string
         default: 'false'
       machine-type:

.github/workflows/swap-orchard1-azure-web-app-slots.yml

@@ -35,7 +35,7 @@ on:
 
     inputs:
       cancel-workflow-on-failure:
-        description: When set to "true", will cancel the current workflow run with all jobs if this workflow fails.
+        description: When set to "true", it will cancel the current workflow run with all jobs if this workflow fails.
         type: string
         default: 'false'
       machine-type:

.github/workflows/test-analysis-failure.yml

@@ -12,7 +12,7 @@ on:
 
     inputs:
       cancel-workflow-on-failure:
-        description: When set to "true", will cancel the current workflow run with all jobs if this workflow fails.
+        description: When set to "true", it will cancel the current workflow run with all jobs if this workflow fails.
         type: string
         default: 'true'
       # This needs to be stringified JSON because inputs don't support arrays, see
@@ -36,14 +36,14 @@ on:
         default: 'false'
         description: >
           If set to "true", the NuGet packages will be cached by GitHub. This is faster if you have a lot of NuGet
-          packages, but negligible or even slower if you only have a handful. When run on BuildJet, will use the
+          packages, but negligible or even slower if you only have a handful. When run on BuildJet, it will use the
           BuildJet cache instead of GitHub's, which is faster.
       build-enable-npm-caching:
         type: string
         default: 'false'
         description: >
           If set to "true", the NPM packages will be cached by GitHub. This is faster if you have a lot of NPM packages,
-          packages, but negligible or even slower if you only have a handful. When run on BuildJet, will use the
+          packages, but negligible or even slower if you only have a handful. When run on BuildJet, it will use the
           BuildJet cache instead of GitHub's, which is faster.
       build-cache-version:
         type: string