chore: satisfy Registrator AutoMerge guidelines automatically#20
Merged
sotashimozono merged 1 commit intomainfrom Apr 15, 2026
Merged
chore: satisfy Registrator AutoMerge guidelines automatically#20sotashimozono merged 1 commit intomainfrom
sotashimozono merged 1 commit intomainfrom
Conversation
Mirrors sotashimozono/Lattice2D.jl#23: makes release-drafter, PRLabeler, PR template and AutoRegister wrap every drafted set of release notes with a '## Changelog' header, so Registrator's required 'breaking' / 'changelog' keyword is always present on the '@JuliaRegistrator register' comment. Also adds the 'breaking' label as a first-class citizen that forces a minor version bump.
|
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
2 participants
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
Aligns this repo's CI automation with the shared registry-guideline fix
rolled out across the sotashimozono Julia package fleet (sibling PRs
on Lattice2D / QuasiCrystal / ...). Makes every future Project.toml
version bump clear Registrator's AutoMerge guidelines without any
human
[merge approved]intervention.What changes
release-drafter.ymlbreakinglabel now triggers theminorversion-resolver, soany PR ticked as breaking automatically forces a minor bump.
💥 Breaking changescategory (unless the repo already hadone under a different name / label).
## Changelogto the rendered template body.PULL_REQUEST_TEMPLATE.md— adds a Breaking change checkboxunder Type of Change.
PRLabeler.yml(if present and using the standard structure) —bootstraps the
breakinglabel and auto-applies it when thecheckbox is ticked.
AutoRegister.yml(orAutoRegister.yml.disabled— keptdisabled) — always wraps the drafted release notes in a literal
## Changelogheader and aSee the full changelog at ...footerbefore posting the
@JuliaRegistrator registercomment. Thisguarantees Registrator's required "breaking"/"changelog" keyword is
present, which was the last remaining rejection cause on the fleet.
Why this matters
Registrator's AutoMerge guideline rejects breaking-change registrations
whose release notes lack the literal word "breaking" or "changelog".
With the wrapper in
AutoRegister.yml, that keyword is always present,so no manual re-trigger is ever needed.
Scope
This PR only touches
.github/files and is version-bump-neutral — noProject.tomlchange. The next feature/fix PR on this repo will bethe first one to exercise the new flow end-to-end.
Type of Change
enhancement)bug)performance)documentation)choreorrefactor)breaking)