Skip to content

fix(ci): exempt release/* PRs from the Changelog Guard#29

Merged
hi-lei merged 1 commit into
mainfrom
ci/exempt-release-changelog-guard
Jun 2, 2026
Merged

fix(ci): exempt release/* PRs from the Changelog Guard#29
hi-lei merged 1 commit into
mainfrom
ci/exempt-release-changelog-guard

Conversation

@hi-lei

@hi-lei hi-lei commented Jun 2, 2026

Copy link
Copy Markdown
Collaborator

Problem

The Release workflow (release.yml) opens an automated release/<version> PR that carries the git-cliff-generated CHANGELOG.md update into main. But the Changelog Guard in ci.yml fails any PR that modifies CHANGELOG.md. Result: every release PR fails the guard and can never go green — 12 stale release PRs (v1.1.0 → v1.4.2) accumulated, and main's changelog never advanced past v1.0.0.

Fix

Skip the Changelog Guard when the PR head branch is release/*:

if: github.event_name == 'pull_request' && !startsWith(github.head_ref, 'release/')
  • Feature PRs remain guarded — humans still can't hand-edit CHANGELOG.md.
  • Release PRs now skip the guard. The ci-success gate already treats a skipped changelog-guard as passing (ci.yml), so release PRs go green.

🤖 Generated with Claude Code

The Release workflow opens an automated release/<version> PR carrying the
git-cliff-generated CHANGELOG.md update. The Changelog Guard failed every
such PR ("CHANGELOG.md should not be modified manually"), so release PRs
could never go green and piled up open. Skip the guard when the PR head
branch is release/*; feature PRs remain guarded. The ci-success gate
already treats a skipped guard as passing.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@hi-lei hi-lei merged commit 7894ed1 into main Jun 2, 2026
11 of 12 checks passed
@hi-lei hi-lei deleted the ci/exempt-release-changelog-guard branch June 2, 2026 20:21
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