Skip to content
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

docs: Add a basic release checklist #90

Merged
merged 1 commit into from
Jan 26, 2025
Merged

docs: Add a basic release checklist #90

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
18 changes: 18 additions & 0 deletions RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
The process for cutting a new release

- [ ] Check for unused dependencies
- `$ cargo +nightly udeps`
- [ ] Bump the `version` in `Cargo.toml`
- [ ] Propagate the change to `Cargo.lock`
- `$ cargo check`
- [ ] Update `rust-version` in `Cargo.toml`
- Comment out the existing `rust-version`
- `$ cargo msrv find [--ignore-lockfile]`
- [ ] Update the `CHANGELOG.md` to reflect any of the changes
- [ ] Merge changes through a PR or directly to make sure CI passes
- [ ] Publish on crates.io
- `$ cargo publish`
- [ ] Publish on GitHub by pushing a version tag
- `$ git tag v{VERSION}` (make sure the branch you are on is up to date)
- `$ git push upstream/origin v{VERSION}`
- [ ] Make a release announcement on GitHub after the release workflow finishes
Loading