Skip to content

fix(release-nudge): stop mandating a NEWS.md changelog step - #67

Merged
seabbs merged 1 commit into
mainfrom
fix/release-nudge-changelog-step
Aug 25, 2026
Merged

fix(release-nudge): stop mandating a NEWS.md changelog step#67
seabbs merged 1 commit into
mainfrom
fix/release-nudge-changelog-step

Conversation

@seabbs-bot

Copy link
Copy Markdown
Collaborator

Closes #45.

What

Drops the NEWS.md clause from steps_text in release-nudge.yml and adds a
prompt to step 3 to read the published release notes.

Step 2 now reads:

Merge that pull request into main. The Register workflow and the
/register slash command always act on main's current HEAD commit, never
on a PR branch, so the bump must land on main first.

The load-bearing "the bump must land on the default branch first" clause is
untouched.

Why option 3 rather than the issue's preferred option 2

The issue preferred rewording toward "update NEWS.md if this repo maintains
one". Since it was filed, the one-repo decision became the org standard: the
kit seeds no changelog at all
(EpiAwarePackageTools.jl/src/scaffold.jl:298, "No NEWS.md seed: release notes
are written on the GitHub release itself"), and
src/scaffold.jl:445 _PROSE_CHANGELOGS treats NEWS.md, CHANGELOG.md and
release-notes.md as legacy to warn about. A conditional clause would keep
asserting a convention the standard has dropped, so dropping the sentence is
now the more correct option.

On the JuliaRegistrator comment in the thread

That concerns the issue body, not this workflow. release-nudge.yml already
records at lines 22-25 that no handle is written anywhere in the file, not even
the registry bot's own, not even inside a code span, and
grep -n 'JuliaRegistrator' .github/workflows/release-nudge.yml returns
nothing. The issue body has been edited separately to defuse the trigger
string.

Validation

python3 -c "import yaml; yaml.safe_load(open('.github/workflows/release-nudge.yml'))"
passes. Nudge staleness is keyed on the release-nudge-state marker (version
and unreleased commit count), not on the prose, so this text change does not
churn open nudge issues.

This was opened by a bot. Please ping @seabbs for any questions.

Release notes are written on the GitHub release itself across the org,
so the nudge asserts a changelog convention it cannot verify and that
several repos deliberately do not keep. Step 3 gains a prompt to read
the published notes, which is the check the step was reaching for.

Co-authored-by: Sam Abbott <contact@samabbott.co.uk>

@seabbs-review-bot seabbs-review-bot Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The PR removes the mandatory NEWS.md-update step from the release-nudge comment and replaces it with a prompt to check the published release notes, since not all repos keep a NEWS.md. The change is a clean, self-contained edit to a Julia string builder with no other references to NEWS.md left dangling elsewhere in the repo, but the new sentence added to step 3 has a grammar error.

Automated first pass by seabbs-review-bot (Claude sonnet), triggered by: first pass. Not a human review. Comment @seabbs-review-bot to ask for another pass: @seabbs any time, the author's agent once it has pushed changes. Add the no-review label to opt this PR out. Ping @seabbs with any questions.

"`/register` on an issue or pull request, or run " *
"the Register workflow manually from the Actions tab."
"the Register workflow manually from the Actions " *
"tab, then check the published release notes read " *

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue This renders as "...run the Register workflow manually from the Actions tab, then check the published release notes read sensibly." — missing "that", so it's not a grammatical sentence. Since this is the whole point of the PR (replacing the NEWS.md check with a release-notes check), it's worth getting right: "...tab, then check that the published release notes read sensibly."

@seabbs-review-bot seabbs-review-bot Bot added the llm-reviewed Reviewed by seabbs-review-bot label Aug 24, 2026
@seabbs
seabbs merged commit 0e42b99 into main Aug 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

llm-reviewed Reviewed by seabbs-review-bot

Projects

None yet

Development

Successfully merging this pull request may close these issues.

release-nudge hardcodes a NEWS.md changelog step, conflicting with repos that point NEWS at GitHub Releases

2 participants