Automate release notes and document the release process - #78
Merged
Conversation
- .github/release.yml: group auto-generated release notes (from `gh release create --generate-notes`) by PR label; unlabelled PRs fall under "Other Changes"; exclude bots. - RELEASING.md: document the one-command release flow (tag a GitHub Release -> publish.yml builds + publishes to PyPI via Trusted Publishing), the setuptools_scm versioning, and the trusted-publisher config. Keeps the release trigger manual (deliberate cadence + version control) while removing the note-writing toil.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #78 +/- ##
=======================================
Coverage 96.80% 96.80%
=======================================
Files 25 25
Lines 1629 1629
=======================================
Hits 1577 1577
Misses 52 52
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
- .github/release.yml: exclude dependabot[bot]/github-actions[bot] (the real bot logins carry the [bot] suffix; without it the exclusion is inert). - RELEASING.md: setuptools_scm guess-next-dev bumps the patch, so the between- releases example is 0.2.1.dev5+g<sha> (after v0.2.0), not 0.2.0.dev5.
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.
Follow-up to the PyPI setup (#77): keep the release trigger manual (deliberate cadence + version control) but remove the note-writing toil.
.github/release.yml— configures GitHub's auto-generated release notes: merged PRs are grouped by label (Features / Fixes / Documentation / Dependencies), unlabelled PRs fall under Other Changes (catch-all is last, as GitHub requires), and bot PRs are excluded. Sogh release create vX.Y.Z --generate-notesproduces clean categorised notes.RELEASING.md— the one-command release flow (tag a GitHub Release →publish.ymlbuilds + publishes to PyPI via Trusted Publishing),setuptools_scmversioning (dev versions are PyPI-rejected — a safety net), the trusted-publisher config values, and a pointer to the conda-forge prerequisite.Deliberately not adopting semantic-release/release-please — that would impose conventional commits and remove control over version/timing, which isn't the right default for an alpha scientific package.