-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #46 from hiltontj/add-release-checklist
Add a Release Checklist
Showing
1 changed file
with
16 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# Steps to Perform in the Event of a Release | ||
|
||
- [ ] Ensure local `main` is up-to-date with `origin/main` | ||
- [ ] Run `cargo update` | ||
- [ ] Run `cargo test` | ||
- [ ] Create a new branch: `release-X-Y-Z` | ||
- [ ] Run `git diff` between current commit and previous tagged release commit | ||
- [ ] Check which crates have been modified; these will need their versions bumped | ||
- [ ] If sub-crates, e.g., `serde_json_path_core`, have their version bumped, check their super-crates, e.g., `serde_json_path`, for dependency update | ||
- [ ] Move Unreleased changes into the new version header in `serde_json_path/CHANGELOG.md` | ||
- [ ] Commit changes and push to `origin/main` | ||
- [ ] Open a pull request to merge changes into `main`, and allow CI to run successfully | ||
- [ ] Merge the PR and jump back to `main` locally | ||
- [ ] For each crate, in sub-crate to super-crate order, publish the crates from the workspace that had their versions bumped: | ||
- [ ] Run `cargo publish -p <crate name> —dry-run`, to check that all is good | ||
- [ ] Run `cargo publish -p <crate name>`, to do the actual release |