chore: address review feedback on registry-guideline automation#23
Merged
sotashimozono merged 1 commit intomainfrom Apr 15, 2026
Merged
Conversation
- PRLabeler now removes the 'breaking' label when the checkbox is unticked, so a stale label can't force a minor bump. - AutoRegister uses a random $GITHUB_OUTPUT heredoc delimiter (openssl rand -hex 16) instead of the fixed RELEASE_NOTES_EOF. - PR template uses generic 'breaking-changes section' wording instead of promising an exact '## Breaking changes' header.
|
Comments on pull requests will not trigger Registrator, as it is disabled. Please try commenting on a commit or issue. |
Codecov Report✅ All modified and coverable lines are covered by tests. 🚀 New features to boost your workflow:
|
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
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.
Summary
Addresses review feedback on the registry-guideline automation PR that already merged into this repo (sibling of sotashimozono/Lattice2D.jl#23 / #35 on QAtlas). Three small fixes, all localised to
.github/:1. PRLabeler: the
breakinglabel no longer sticksPreviously PRLabeler only ever added the
breakinglabel based on the Type-of-Change checkbox. If a contributor checked the box, saved the PR body, and then unchecked it, the label remained — and since release-drafter usesbreakingto force a minor bump, that stale label could silently promote a patch release into a minor one.The workflow now toggles both directions: when the checkbox is unticked (or absent), it runs
gh pr edit ... --remove-label breaking(error-tolerant, so it's a no-op when the label was never applied).2. AutoRegister: unique
$GITHUB_OUTPUTheredoc delimiterThe
Generate release notes textstep used a fixedRELEASE_NOTES_EOFdelimiter when writing the wrapped body to$GITHUB_OUTPUT. The drafted release body is effectively user-controlled — a draft that happens to contain a line literally equal toRELEASE_NOTES_EOFwould truncate the output and corrupt the@JuliaRegistrator registercomment body.Replaced with a random delimiter per run:
3. PR template: generic "breaking-changes section" wording
The checkbox description previously promised a
`## Breaking changes`section in the drafted release notes. release-drafter's actual category titles vary across the fleet (💥 Breaking changes/⚠️ Breaking Changes), so the exact header string was never guaranteed. Reworded to the generic "breaking-changes section" — same meaning, no false promise.Test plan
AutoRegisterfires, the posted Registrator comment body is intact even for multi-line drafts.Type of Change
enhancement)bug)performance)documentation)choreorrefactor)breaking)