docs(github action): suggest using concurrency (#1744)

MarcoIeni · Oct 5, 2024 · 2e597d7 · 2e597d7
1 parent 69ad93e
commit 2e597d7
Show file tree

Hide file tree

Showing 6 changed files with 51 additions and 0 deletions.
diff --git a/.github/workflows/release-plz.yml b/.github/workflows/release-plz.yml
@@ -14,6 +14,9 @@ jobs:
   release-plz:
     name: Release-plz
     runs-on: ubuntu-24.04
+    concurrency:
+      group: release-plz-${{ github.ref }}
+      cancel-in-progress: false
     steps:
       # Generating a GitHub token, so that PRs and tags created by
       # the release-plz-action can trigger actions workflows.

diff --git a/crates/release_plz/src/init/mod.rs b/crates/release_plz/src/init/mod.rs
@@ -122,6 +122,9 @@ jobs:
   release-plz:
     name: Release-plz
     runs-on: ubuntu-latest
+    concurrency:
+      group: release-plz-${{{{ github.ref }}}}
+      cancel-in-progress: false
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
@@ -179,6 +182,9 @@ mod tests {
               release-plz:
                 name: Release-plz
                 runs-on: ubuntu-latest
+                concurrency:
+                  group: release-plz-${{ github.ref }}
+                  cancel-in-progress: false
                 steps:
                   - name: Checkout repository
                     uses: actions/checkout@v4

diff --git a/website/docs/github/advanced.md b/website/docs/github/advanced.md
@@ -14,6 +14,9 @@ jobs:
   release-plz:
     name: Release-plz
     runs-on: ubuntu-latest
+    concurrency:
+      group: release-plz-${{ github.ref }}
+      cancel-in-progress: false
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
@@ -54,6 +57,9 @@ If you want to run other checks before releasing (e.g. `cargo test`), you have t
      release-plz:
        name: Release-plz
        runs-on: ubuntu-latest
+       concurrency:
+         group: release-plz-${{ github.ref }}
+         cancel-in-progress: false
        steps:
          - name: Checkout repository
            uses: actions/checkout@v4
@@ -83,6 +89,9 @@ jobs:
   release-plz:
     name: Release-plz
     runs-on: ubuntu-latest
+    concurrency:
+      group: release-plz-${{ github.ref }}
+      cancel-in-progress: false
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4

diff --git a/website/docs/github/output.md b/website/docs/github/output.md
@@ -33,6 +33,9 @@ After the action runs, it outputs the following properties:
 jobs:
   test:
     runs-on: ubuntu-latest
+    concurrency:
+      group: release-plz-${{ github.ref }}
+      cancel-in-progress: false
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
@@ -111,6 +114,9 @@ configuration field.
 jobs:
   test:
     runs-on: ubuntu-latest
+    concurrency:
+      group: release-plz-${{ github.ref }}
+      cancel-in-progress: false
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
@@ -169,6 +175,9 @@ You can commit files to the release PR opened by release-plz.
 jobs:
   test:
     runs-on: ubuntu-latest
+    concurrency:
+      group: release-plz-${{ github.ref }}
+      cancel-in-progress: false
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4

diff --git a/website/docs/github/quickstart.md b/website/docs/github/quickstart.md
@@ -75,6 +75,9 @@ jobs:
   release-plz:
     name: Release-plz
     runs-on: ubuntu-latest
+    concurrency:
+      group: release-plz-${{ github.ref }}
+      cancel-in-progress: false
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
@@ -93,6 +96,12 @@ Notes:
 
 - `fetch-depth: 0` is needed to clone all the git history, which is necessary to
   determine the next version and build the changelog.
+- The `concurrency` block guarantees that if a new commit is pushed while the job of the previous
+  commit was still running, the new job will wait for the previous one to finish.
+  In this way, only one instance of release-plz will run in the repository at the same time for
+  the same branch, ensuring that there are no conflicts.
+  See the GitHub [docs](https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idconcurrency)
+  to learn more.
 
 ### Example: release-pr only
 
@@ -115,6 +124,9 @@ jobs:
   release-plz:
     name: Release-plz
     runs-on: ubuntu-latest
+    concurrency:
+      group: release-plz-${{ github.ref }}
+      cancel-in-progress: false
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
@@ -151,6 +163,9 @@ jobs:
   release-plz:
     name: Release-plz
     runs-on: ubuntu-latest
+    concurrency:
+      group: release-plz-${{ github.ref }}
+      cancel-in-progress: false
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
@@ -191,6 +206,9 @@ jobs:
   release-plz:
     name: Release-plz
     runs-on: ubuntu-latest
+    concurrency:
+      group: release-plz-${{ github.ref }}
+      cancel-in-progress: false
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
@@ -234,6 +252,9 @@ jobs:
   release-plz:
     name: Release-plz
     runs-on: ubuntu-latest
+    concurrency:
+      group: release-plz-${{ github.ref }}
+      cancel-in-progress: false
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4

diff --git a/website/docs/github/token.md b/website/docs/github/token.md
@@ -120,6 +120,9 @@ jobs:
   release-plz:
     name: Release-plz
     runs-on: ubuntu-latest
+    concurrency:
+      group: release-plz-${{ github.ref }}
+      cancel-in-progress: false
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4