Skip to content

Document creating a GitHub release when rolling a release #47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
michaelklishin merged 1 commit into from
Aug 12, 2026
Merged

Document creating a GitHub release when rolling a release #47

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,10 +89,11 @@ To produce a new release:
1. Update `ChangeLog.md`: replace `(in development)` with today's date, e.g. `(Mar 30, 2026)`. Make sure all notable changes since the previous release are listed
2. Update the version in `lib/sneakers/version.rb` to match (remove the `.pre` suffix)
3. Commit with the message `X.(Y+1).0` (just the version number, nothing else)
4. Tag the commit: `git tag vX.(Y+1).0`
4. Tag the commit: `git tag X.(Y+1).0` (tag names do not use a `v` prefix)
5. Bump the dev version: add a new `## Changes Between X.(Y+1).0 and X.(Y+2).0 (in development)` section to `ChangeLog.md` with `No (documented) changes yet.` underneath, and update `lib/sneakers/version.rb` to the next dev version with a `.pre` suffix
6. Commit with the message `Back to dev version`
7. Push: `git push && git push origin vX.(Y+1).0`
7. Push: `git push && git push origin X.(Y+1).0`
8. Create a GitHub release off the new tag: `gh release create X.(Y+1).0 --title "X.(Y+1).0" --notes-file <notes>`, where `<notes>` is a file holding the `ChangeLog.md` section of this release

## Git Instructions

Expand Down