ci: refine changelog gate to user-facing changes only#701
Merged
Conversation
The gate previously treated every file under src/ as user-facing, so purely internal changes (e.g. handle-typing fixes) still demanded a release note. Path classification can't perfectly tell user-facing behavior from internal plumbing, so this adds both a tighter default and a human override: - Exclude the generated weather_gov_api_client/ from the user-facing set. - Honor a `skip-changelog` PR label (ci.yml `if:` guard) for internal PRs. - Honor a `Changelog: none` / `[skip changelog]` commit trailer for direct pushes, but only when every non-merge commit in the range carries it, so a marker can't mask a user-facing commit. Adds unit tests for the exclusion and the all-commits opt-out rule, and documents both escape hatches in the workflow README. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The changelog gate treated every file under
src/as user-facing, so purely internal changes (like the recent 64-bit handle-typing fix insingle_instance.py) still demanded a release note. No path rule can perfectly separate user-facing behavior from internal plumbing — the same file holds both at different times — so the fix is a tighter default plus a human override.Changes
Tighter default
src/accessiweather/weather_gov_api_client/client from the user-facing set (checked before thesrc/prefix)..github/,tests/,docs/, and most ofscripts/were already exempt — unchanged.Escape hatches (for the internal changes a path list can't classify)
skip-changeloglabel skips theCheck CHANGELOG entrystep via the workflowif:guard. For non-PR events the labels expression is null, so pushes still run the gate.Changelog: none/[skip changelog]commit trailer. The gate passes only when every non-merge commit in the range carries the marker, so a marker can't silently exempt a change set that also contains user-facing work.Tests / docs
.github/workflows/README.md.skip-changeloglabel created in the repo.This PR dogfoods the change:
changelog_tools.py,ci.yml, and the tests are all correctly classified as non-user-facing, so it needs no changelog entry of its own.🤖 Generated with Claude Code