From 5157a90fa2a4515343fa118e990134fb4af6082e Mon Sep 17 00:00:00 2001 From: Trevor Hilton Date: Wed, 5 Jul 2023 07:42:30 -0400 Subject: [PATCH 1/2] add release checklist --- RELEASE-CHECKLIST.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 RELEASE-CHECKLIST.md diff --git a/RELEASE-CHECKLIST.md b/RELEASE-CHECKLIST.md new file mode 100644 index 0000000..90b8ff3 --- /dev/null +++ b/RELEASE-CHECKLIST.md @@ -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 —dry-run`, to check that all is good + - [ ] Run `cargo publish -p `, to do the actual release From 849abd7cacadbf50ddb69c97dcb4f3ba9a258bbd Mon Sep 17 00:00:00 2001 From: Trevor Hilton Date: Wed, 5 Jul 2023 07:45:14 -0400 Subject: [PATCH 2/2] remove comma --- RELEASE-CHECKLIST.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/RELEASE-CHECKLIST.md b/RELEASE-CHECKLIST.md index 90b8ff3..4f43360 100644 --- a/RELEASE-CHECKLIST.md +++ b/RELEASE-CHECKLIST.md @@ -1,4 +1,4 @@ -# Steps to Perform, in the Event of a Release +# Steps to Perform in the Event of a Release - [ ] Ensure local `main` is up-to-date with `origin/main` - [ ] Run `cargo update`