@ebalzan/ci 2.0.0 → 2.0.2

package/README.md

@@ -77,7 +77,7 @@ git push -u origin feat/search-filters
 - the milestone and the project board, when the repo configures them;
 - an AI-written description.
 
-It opens the PR as a draft and marks it ready for review once all of that is done.
+PR Checks runs once per push and waits for Auto PR to finish, so it checks the finished PR.
 
 While you work, keep the branch on top of `dev` by **rebasing, never merging**. The branch is yours, so rewriting it is fine:
 
@@ -117,7 +117,7 @@ Its check (`pr-check / Release PR`) holds it to the computed title. It also requ
 
 When the release PR's check passes, **add the `ship` label**. The **Release** workflow then does this:
 
-1. **Verify.** `dev` is still the PR's head, `main` fast-forwards to it, there's no merge commit, and the PR check passed. If the check is still running, it waits.
+1. **Verify.** `dev` is still the PR's head, `main` fast-forwards to it, there's no merge commit, and the PR check passed. If the check is still running, it waits. Adding the label doesn't run the check again: PR Checks skips that one event, and Release reads the result the commit already has. Removing the label still runs it.
 2. **Version and tag.** It recomputes the title and requires it to equal the PR's. In a Node repo it commits `chore(release): X.Y.Z` to bump `package.json`. Then it pushes **`main` and `dev` to that same commit**, along with `vX.Y.Z` and the moving major tag `vX`, in **one atomic push**.
 3. **Publish.** It creates the GitHub Release `vX.Y.Z`, using the PR's description as the notes.
 4. **Deploy.** It calls the repo's own `.github/workflows/deploy.yml` with the new tag.
@@ -260,6 +260,16 @@ In v1, the release PR was merged with a merge commit. In v2 it ships with the `s
 
 Do steps 2–4 together. The old `release.yml` expects a merge commit, and step 3 turns merge commits off.
 
+## Skipping PR Checks on the `ship` label
+
+Adding `ship` to the release PR doesn't need to re-run PR Checks. `actions/release` picks this up through `@v2`, but `pr-checks.yml` is the repo's own file. Per repo, by hand, because `onboard --force` would drop the repo's own jobs:
+
+1. In the `release-pr` job's `if`, add `&& !(github.event.action == 'labeled' && github.event.label.name == 'ship')`. Leave `work-pr` as it is.
+2. In the `if` of each of the repo's own jobs, add `&& !(github.event.action == 'labeled' && github.event.label.name == 'ship' && github.event.pull_request.head.ref == 'dev')`.
+3. Change the concurrency group to `pr-checks-${{ github.event.pull_request.number }}${{ github.event.action == 'labeled' && github.event.label.name == 'ship' && github.event.pull_request.head.ref == 'dev' && '-ship' || '' }}`.
+
+Repos that don't change keep working, and keep re-running their checks on `ship`.
+
 ## Developing this repo
 
 ```sh

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ebalzan/ci",
-  "version": "2.0.0",
+  "version": "2.0.2",
   "description": "One set of CI/CD rules for all your GitHub repos: reusable workflows (auto work and release PRs with AI descriptions, PR checks, semver releases), a CLI that syncs Actions config, repo settings and branch rulesets, and a commitlint commit-msg hook.",
   "keywords": [
     "github-actions",

package/templates/.github/workflows/auto-pr.yml

@@ -31,7 +31,7 @@ jobs:
     # Renovate opens and rewrites its own PR on these branches.
     if: ${{ !startsWith(github.ref_name, 'chore/renovate-') }}
     runs-on: __RUNS_ON__
-    # Queued, never cancelled: a run cut short could leave its new PR in draft.
+    # Queued, never cancelled: a run cut short could leave its new PR half filled in.
     concurrency:
       group: auto-pr-${{ github.ref }}
       cancel-in-progress: false

package/templates/.github/workflows/pr-checks.yml

@@ -13,9 +13,16 @@
 # The other kind is skipped, as are drafts. Keep the two job names as they are:
 # they are the check names the shared rulesets require.
 #
-# The PR's metadata is part of the check, so it also re-runs when the title,
-# description, labels, milestone or assignees change.
-# Add this repo's own build/test/lint jobs below; they run in parallel.
+# The PR's metadata is part of the check, so it also re-runs when someone changes
+# the title, description, labels, milestone or assignees. Auto PR's own edits
+# start no run: on a push or a new PR, the one run waits for Auto PR to finish.
+# One exception: adding `ship` to the release PR starts the Release workflow,
+# which reads the result its head already has, so these jobs skip that one event.
+# GitHub cannot filter a trigger by label name, and those runs get a concurrency
+# group of their own, so they never cancel a real check. Every other event runs
+# as usual, removing `ship` included.
+# Add this repo's own build/test/lint jobs below; they run in parallel. Give each
+# one the same condition as the release-pr job.
 # Generated by `ebalzan-ci onboard`; the check logic lives in the action (it
 # follows __CI_REF__).
 # =============================================================================
@@ -42,7 +49,7 @@ permissions:
   pull-requests: write
 
 concurrency:
-  group: pr-checks-${{ github.event.pull_request.number }}
+  group: pr-checks-${{ github.event.pull_request.number }}${{ github.event.action == 'labeled' && github.event.label.name == 'ship' && github.event.pull_request.head.ref == 'dev' && '-ship' || '' }}
   cancel-in-progress: true
 
 env:
@@ -73,7 +80,7 @@ jobs:
 
   release-pr:
     name: pr-check / Release PR
-    if: ${{ github.event.pull_request.head.ref == 'dev' && !github.event.pull_request.draft }}
+    if: ${{ github.event.pull_request.head.ref == 'dev' && !github.event.pull_request.draft && !(github.event.action == 'labeled' && github.event.label.name == 'ship') }}
     runs-on: __RUNS_ON__
     steps:
       # Full history with the tags: git-cliff computes the version from them.
@@ -96,6 +103,7 @@ jobs:
   # steps (e.g. `go test ./...`).
   # validate:
   #   name: Validate
+  #   if: ${{ !github.event.pull_request.draft && !(github.event.action == 'labeled' && github.event.label.name == 'ship' && github.event.pull_request.head.ref == 'dev') }}
   #   runs-on: __RUNS_ON__
   #   steps:
   #     - uses: actions/checkout@v4