From fbc18a386bb9f87dba0d824c42d4ebb3268ae71a Mon Sep 17 00:00:00 2001 From: Paul Nothaft <53005142+the-luap@users.noreply.github.com> Date: Thu, 30 Jul 2026 12:14:21 +0200 Subject: [PATCH] ci: batch stable releases into one daily version (#919) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * ci: batch stable releases into one daily version The stable release PR was auto-merged the instant it went green, so a day with N bugfixes produced N patch releases (3.45.8 AND 3.45.9 on 2026-07-29 alone) — N upgrade notifications for stable users and N full Docker build cycles. Fixes now accumulate in release-please's rolling release PR and are cut as ONE version per day by release-stable-daily.yml (18:00 UTC). Approval/merge mechanics are unchanged from the inline step (#719): approve as github-actions[bot], auto-merge as the PAT so the merge triggers the tag-cutting run. - Urgent fix? workflow_dispatch the daily job or merge the release PR by hand — the schedule is a default, not a gate. - Beta is untouched: instant beta releases are load-bearing for same-day reporter verification. - schedule only fires from the default branch; the stable copy of the new workflow is inert and exists to keep branches in sync. * ci: harden the daily stable-release cut (review round) - P1: the daily job runs on a schedule, so a fork PR can spoof the head branch name 'release-please--branches--stable' — gh --head matches the name only. Pin --base stable AND require isCrossRepository == false so a fork PR can never be approved+auto-merged with the release PAT. - P2: this scheduled job is now the ONLY automatic stable cut, so the auto-merge-enable step no longer swallows failures (|| true); it fails loudly and verifies autoMergeRequest is actually set. A silently expired PAT would otherwise stop releases while the workflow stays green. Approve stays tolerant (re-approval can return non-zero). * ci: accept an immediately-merged release PR as success (review round 2) gh pr merge --auto merges immediately when required checks are already green — the normal 18:00 case, since fixes land hours earlier and CI passes. The autoMergeRequest verify then saw null on a MERGED PR and failed the job on the happy path. Now: MERGED = success, pending auto-merge = success, still-open-with-no-auto-merge = real failure. * ci: read release-PR state + auto-merge in one snapshot (review round 3) Two separate gh pr view calls raced: a pending auto-merge completing between them made the first read OPEN and the second read null on the now-merged PR, failing the job on a successful release. Fetch state and autoMergeRequest together. --------- Co-authored-by: Paul Nothaft --- .github/workflows/release-please.yml | 32 ++------ .github/workflows/release-stable-daily.yml | 86 ++++++++++++++++++++++ 2 files changed, 92 insertions(+), 26 deletions(-) create mode 100644 .github/workflows/release-stable-daily.yml diff --git a/.github/workflows/release-please.yml b/.github/workflows/release-please.yml index 4063617f..59b8c8b4 100644 --- a/.github/workflows/release-please.yml +++ b/.github/workflows/release-please.yml @@ -27,32 +27,12 @@ jobs: manifest-file: .release-please-manifest.json target-branch: stable - # Auto-approve + auto-merge the open stable release PR. See the beta - # workflow for the full rationale. Skipped on the release-cutting run and - # whenever no PAT is configured. - - name: Auto-approve and enable auto-merge on the release PR - if: ${{ steps.release.outputs.release_created != 'true' }} - env: - GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} - RELEASE_PAT: ${{ secrets.RELEASE_PLEASE_TOKEN }} - # No checkout in this job — set the repo explicitly so gh works - # without a git remote (same pattern as whatsnew, 2a5f0a8). - GH_REPO: ${{ github.repository }} - run: | - if [ -z "$RELEASE_PAT" ]; then - echo "RELEASE_PLEASE_TOKEN not set — skipping auto-merge (manual review still required)." - exit 0 - fi - pr=$(gh pr list --head release-please--branches--stable --state open --json number --jq '.[0].number // empty') - if [ -n "$pr" ]; then - # Approve as github-actions[bot] (GITHUB_TOKEN, ≠ the PAT author) so it - # is a valid review; enable auto-merge as the PAT so the merge commit is - # attributed to a real identity and triggers the tag-cutting run (#719). - gh pr review "$pr" --approve --body "Automated approval — release-please version bump + changelog (#719)." || true - GH_TOKEN="$RELEASE_PAT" gh pr merge "$pr" --squash --auto || true - else - echo "No open release PR to auto-merge." - fi + # NOTE: stable release PRs are intentionally NOT auto-merged here + # anymore. Fixes accumulate in the rolling release PR and are cut as + # ONE patch version per day by release-stable-daily.yml (18:00 UTC, + # or on demand via workflow_dispatch / a manual merge of the release + # PR). Beta keeps instant releases — see release-please-beta.yml — + # because same-day reporter verification depends on it. - name: Output Release Info if: ${{ steps.release.outputs.release_created }} diff --git a/.github/workflows/release-stable-daily.yml b/.github/workflows/release-stable-daily.yml new file mode 100644 index 00000000..69e4ead6 --- /dev/null +++ b/.github/workflows/release-stable-daily.yml @@ -0,0 +1,86 @@ +name: Cut Stable Release (daily batch) + +# Stable fixes accumulate in release-please's rolling release PR instead of +# each cutting its own patch version (the old per-merge auto-merge produced +# e.g. 3.45.8 AND 3.45.9 on the same day). This workflow merges the open +# stable release PR once a day, so a day of N bugfixes ships as ONE version +# with all N changelog entries — and one Docker build instead of N. +# +# - schedule only fires from the default branch (main); the stable copy of +# this file is inert and exists to keep the branches in sync. +# - Need a release NOW? Run this via workflow_dispatch, or merge the +# release PR by hand — the schedule is a default, not a gate. +# - Approval/merge mechanics mirror the old inline step (#719): approve as +# github-actions[bot] (GITHUB_TOKEN, a valid distinct reviewer), enable +# auto-merge as the PAT so the merge attributes to a real identity and +# triggers the tag-cutting run. --auto waits for green checks. + +on: + schedule: + - cron: '0 18 * * *' + workflow_dispatch: + +permissions: + contents: write + pull-requests: write + +jobs: + merge-stable-release-pr: + runs-on: ubuntu-latest + steps: + - name: Approve and enable auto-merge on the open stable release PR + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + RELEASE_PAT: ${{ secrets.RELEASE_PLEASE_TOKEN }} + # No checkout — set the repo explicitly so gh works without a + # git remote (same pattern as whatsnew, 2a5f0a8). + GH_REPO: ${{ github.repository }} + run: | + if [ -z "$RELEASE_PAT" ]; then + echo "RELEASE_PLEASE_TOKEN not set — skipping (manual review required)." + exit 0 + fi + # Strict selection (review P1): this job runs daily even without a + # stable push, and `gh pr list --head` matches the branch NAME only + # — a fork PR can spoof `release-please--branches--stable`. Pin the + # base to stable AND require a same-repo head (isCrossRepository + # == false); a fork PR is cross-repository, so it can never be + # picked and auto-merged with the privileged PAT. + pr=$(gh pr list \ + --base stable \ + --head release-please--branches--stable \ + --state open \ + --json number,isCrossRepository \ + --jq '[.[] | select(.isCrossRepository == false)] | .[0].number // empty') + if [ -z "$pr" ]; then + echo "No open same-repo stable release PR — nothing to cut today." + exit 0 + fi + # Approve is tolerant — a pre-existing approval already satisfies + # branch protection and re-approving can return non-zero. + gh pr review "$pr" --approve --body "Automated approval — daily stable release batch (release-please version bump + changelog)." || echo "::warning::approve returned non-zero (PR may already be approved)" + # But the auto-merge enable is the load-bearing step: this scheduled + # job is the ONLY automatic stable cut, so DON'T swallow its failure + # (review P2) — an expired/under-scoped PAT would otherwise stop + # releases while the workflow stays green. + GH_TOKEN="$RELEASE_PAT" gh pr merge "$pr" --squash --auto + # `gh pr merge --auto` merges IMMEDIATELY when the required checks + # are already green — the normal case at 18:00, since the fixes + # merged hours earlier and CI passed. So success is EITHER the PR is + # already merged OR an auto-merge request is now pending; only a PR + # that is still open with no auto-merge request is a real failure + # (expired/under-scoped PAT) worth failing the job on (review round 2). + # One snapshot of both fields (review round 3): querying state and + # autoMergeRequest separately races — auto-merge can complete + # between the two calls, so the first sees OPEN and the second sees + # the request already cleared on the now-merged PR → false failure. + read -r state automerge < <(gh pr view "$pr" --json state,autoMergeRequest \ + --jq '[.state, (.autoMergeRequest != null)] | @tsv') + if [ "$state" = "MERGED" ]; then + echo "Stable release PR #$pr merged immediately (checks were already green)." + elif [ "$automerge" = "true" ]; then + echo "Auto-merge enabled on stable release PR #$pr — merges when checks are green." + else + echo "::error::stable release PR #$pr is still open with no auto-merge — check RELEASE_PLEASE_TOKEN scope/expiry." + exit 1 + fi