Skip to content

ci: correct why the version PR needs approving - #8

Merged
hughgrigg merged 1 commit into
mainfrom
ci/hg/version-pr-approval
Aug 15, 2026
Merged

ci: correct why the version PR needs approving#8
hughgrigg merged 1 commit into
mainfrom
ci/hg/version-pr-approval

Conversation

@hughgrigg

@hughgrigg hughgrigg commented Aug 15, 2026

Copy link
Copy Markdown
Contributor

The first real release exercised the version write-back path for the first time, and it did not behave the way these comments said it would. They now record what was observed.

What the comments claimed

a pull request opened with that token does not fire pull_request — GitHub declines to let a workflow start another workflow

…and therefore that the push: release/** trigger is what puts the three required checks onto the version pull request.

What actually happened on v0.1.0

push to release/v0.1.0 no run at all — GITHUB_TOKEN genuinely cannot start a workflow, so that trigger never fired
pull_request for #7 did create a run of pr.yml, held as action_required because the actor is github-actions[bot]

Confirmed from the API rather than inferred:

pull_request | success | actor=github-actions[bot] | approved-by=hughgrigg

So half the reasoning was right — GITHUB_TOKEN work does not start runs — and the conclusion drawn from it was wrong. The push trigger has never fired and never will for release.yml's own push; the mechanism is the pull_request run, gated behind one approval.

What changes

Comments only; no behaviour. Both files now say that the version pull request needs one approval click in the Actions tab per release, and why. I checked whether that gate can be waived — repos/…/actions/permissions exposes no approval policy, and the org endpoint needs a scope I do not have — so it is documented rather than worked around. A release is a deliberate act already.

The push: release/** trigger is kept, with its real purpose written down: a person pushing a fixup to a release branch does fire it, and would otherwise get no checks at all.

Summary by CodeRabbit

  • Documentation
    • Clarified automated workflow behavior for release-related pushes and pull requests.
    • Documented when workflow runs require manual approval.
    • Added guidance for human fixup pushes during the release process.

The first real release proved the reasoning in these comments wrong, so
they now record what was observed rather than what was assumed.

The claim was that a pull request opened with GITHUB_TOKEN does not fire
`pull_request`, and that the `push: release/**` trigger is what gets
checks onto the version pull request. Neither half held on v0.1.0. The
push started nothing — GITHUB_TOKEN cannot start a workflow — so that
trigger never fired at all. The pull request did start a run, which
GitHub then held as `action_required` because the actor is
`github-actions[bot]`.

So the checks do report, after one approval click per release. No
repository-level setting to waive that is exposed, and a release is
already a deliberate act, so it stays.

The push trigger is kept, with its real purpose written down: a person
pushing a fixup to a release branch, which does fire and would otherwise
get no checks at all.
@coderabbitai

coderabbitai Bot commented Aug 15, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: bcadb77b-271e-4d09-b1fb-9911a5f2e65c

📥 Commits

Reviewing files that changed from the base of the PR and between 53ed817 and 53af620.

📒 Files selected for processing (2)
  • .github/workflows/pr.yml
  • .github/workflows/release.yml

📝 Walkthrough

Walkthrough

The workflow comments now document observed GitHub Actions behavior for release pushes and bot-created version pull requests. The release/** push trigger remains available for human fixups.

Changes

Workflow trigger documentation

Layer / File(s) Summary
Document release workflow triggers
.github/workflows/pr.yml, .github/workflows/release.yml
Comments explain that GITHUB_TOKEN pushes do not trigger pr.yml, bot-created pull requests require manual approval, and human release/** fixup pushes remain supported.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Merge Risk: ⚪ Minimal · up to 53af6

This comments-only change documents the approval required for version pull requests without changing workflow behavior, so no actionable merge-blocking risk remains beyond normal checks and review.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the CI comment updates that explain why the version pull request requires approval.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch ci/hg/version-pr-approval

Comment @coderabbitai help to get the list of available commands.

@hughgrigg
hughgrigg merged commit 20fca04 into main Aug 15, 2026
6 checks passed
@hughgrigg
hughgrigg deleted the ci/hg/version-pr-approval branch August 15, 2026 15:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant