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

Jump to bottom

Add a Release Checklist #46

Merged
merged 2 commits into from
Jul 5, 2023
Merged

Add a Release Checklist #46

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5157a90
add release checklist
hiltontj Jul 5, 2023
849abd7
remove comma
hiltontj Jul 5, 2023
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
16 changes: 16 additions & 0 deletions RELEASE-CHECKLIST.md
View file
Open in desktop
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