Skip to content

Commit d0b1c73

Browse files
committed
Updated release checklist to include updating the CHANGELOG
1 parent afa8e4e commit d0b1c73

File tree

1 file changed

+17
-15
lines changed

1 file changed

+17
-15
lines changed

RELEASE_CHECKLIST.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,21 @@
22

33
Make sure each of these things are done in sequence before a release.
44

5-
- [ ] 1. `git checkout master` - make sure you are on master
5+
- [ ] 1. `git checkout master` and `git pull` - make sure you are on master and have the latest changes
66
- [ ] 2. Check `Cargo.toml` to make sure you are publishing the intended version
7-
- [ ] 3. Update `docs/_data/lib.json` with the version to be published
8-
- [ ] 3. `git push origin master` - make sure everything is pushed
9-
- [ ] 4. `git status` - nothing to commit, working directory clean
10-
- [ ] 5. `cargo package` - check which files are being included in the build
11-
- [ ] 6. `cargo test --features "test unstable"` - all tests should pass
12-
- [ ] 7. `cargo run --example runtest` - runtest should exit successfully
13-
- [ ] 8. `cargo build --examples` - all examples should build
14-
- [ ] 9. `cargo doc --open` - spot check the documentation for any issues
15-
- [ ] 10. `cargo publish --dry-run` - everything should pass
16-
- [ ] 11. `cargo publish` - this will upload the package and is NOT reversible
17-
- [ ] 12. `git tag v1.2.3` - create a tag with the correct version
18-
- [ ] 13. `git push origin --tags` - push the new tags to the repository
19-
- [ ] 15. Update the version in `Cargo.toml` in master to the next version to be released
20-
- [ ] 16. `git push origin master` - push anything new
7+
- [ ] 3. Update `Unreleased` section in `CHANGELOG.md` to list version being published and update links
8+
- [ ] 4. Update `docs/_data/lib.json` with the version to be published
9+
- [ ] 5. `git push origin master` - make sure everything is pushed
10+
- [ ] 6. `git status` - nothing to commit, working directory clean
11+
- [ ] 7. `cargo package` - check which files are being included in the build
12+
- [ ] 8. `cargo test --features "test unstable"` - all tests should pass
13+
- [ ] 9. `cargo run --example runtest` - runtest should exit successfully
14+
- [ ] 10. `cargo build --examples` - all examples should build
15+
- [ ] 11. `cargo doc --open` - spot check the documentation for any issues
16+
- [ ] 12. `cargo publish --dry-run` - everything should pass
17+
- [ ] 13. `cargo publish` - this will upload the package and is NOT reversible
18+
- [ ] 14. `git tag v1.2.3` - create a tag with the correct version
19+
- [ ] 15. `git push origin --tags` - push the new tags to the repository
20+
- [ ] 17. Update the version in `Cargo.toml` in master to the next version to be released
21+
- [ ] 18. Add a new `Unreleased` section to `CHANGELOG.md` with relevant section headings from https://keepachangelog.com
22+
- [ ] 19. `git push origin master` - push anything new

0 commit comments

Comments
 (0)