Skip to content

chore: address review feedback on registry-guideline automation#23

Merged
sotashimozono merged 1 commit intomainfrom
chore/registry-guideline-review-fixups
Apr 15, 2026
Merged

chore: address review feedback on registry-guideline automation#23
sotashimozono merged 1 commit intomainfrom
chore/registry-guideline-review-fixups

Conversation

@sotashimozono
Copy link
Copy Markdown
Owner

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 breaking label no longer sticks

Previously PRLabeler only ever added the breaking label 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 uses breaking to 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_OUTPUT heredoc delimiter

The Generate release notes text step used a fixed RELEASE_NOTES_EOF delimiter 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 to RELEASE_NOTES_EOF would truncate the output and corrupt the @JuliaRegistrator register comment body.

Replaced with a random delimiter per run:

delim="RELEASE_NOTES_$(openssl rand -hex 16)"
{
  echo "content<<$delim"
  printf '%s\n' "$WRAPPED"
  echo "$delim"
} >> "$GITHUB_OUTPUT"

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

  • Tick and untick the Breaking change checkbox on a throwaway PR → label appears / disappears.
  • Next time AutoRegister fires, the posted Registrator comment body is intact even for multi-line drafts.

Type of Change

  • Feature (enhancement)
  • 🐛 Bug Fix (bug)
  • Performance (performance)
  • 📖 Documentation (documentation)
  • 🧰 Maintenance (chore or refactor)
  • 💥 Breaking change (breaking)

- 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.
@JuliaRegistrator
Copy link
Copy Markdown

Comments on pull requests will not trigger Registrator, as it is disabled. Please try commenting on a commit or issue.

@github-actions github-actions bot added the chore label Apr 15, 2026
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 15, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@sotashimozono sotashimozono merged commit 49c38b0 into main Apr 15, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants