Add release-notes automation, adapted from tomcardoso/watchdog - #14
Merged
Conversation
Same as the version just added to startr, adapted for a CRAN R
package instead of a git-cloned template: on a v* tag push, prefers
a curated "## What's new" section from the version-bump PR's body
(expected branch name: chore/v{VERSION}), falling back to GitHub's
auto-generated PR changelog, and splices the result into
.github/release-template.md before creating/updating the release.
Doesn't touch R-CMD-check.yaml or add any test/build/publish jobs -
CRAN publication stays a manual devtools::submit_cran() step done by
the maintainer, this only handles the GitHub release side.
release-template.md's install instructions point at install.packages()
from CRAN rather than npx/pipx. The env: TAG fix from startr's version
(passing github.ref_name through env: rather than interpolating it
directly into run: shell text) is included from the start here.
Verified the extract + splice scripts end-to-end locally against a
simulated PR body and generated changelog.
Co-Authored-By: Claude Sonnet 5 <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.
Summary
Same as the version just added to
startr(globeandmail/startr#12), adapted for a CRAN R package instead of a git-cloned template. On av*tag push: prefers a curated## What's newsection from the version-bump PR's body (expected branch name:chore/v{VERSION}), falling back to GitHub's auto-generated PR changelog, and splices the result into.github/release-template.mdbefore creating/updating the GitHub release.R-CMD-check.yamlor add any test/build/publish jobs - CRAN publication stays a manualdevtools::submit_cran()step done by the maintainer; this only handles the GitHub release side.release-template.md's install instructions point atinstall.packages()from CRAN rather thannpx/pipx.env: TAGfix (passinggithub.ref_namethroughenv:rather than interpolating it directly intorun:shell text, to avoid a tag-name injection surface) is included from the start here, rather than being a follow-up fix like it was forstartr.Test plan
extract-whats-new.pyandsplice-release-notes.pyend-to-end locally against a simulated PR body and generated changelog - curated bullets take precedence, raw PR list collapses into a<details>block🤖 Generated with Claude Code