summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDavid Peter <mail@david-peter.de>2021-08-21 22:28:54 +0200
committerDavid Peter <sharkdp@users.noreply.github.com>2021-08-22 09:38:35 +0200
commit20223ad77c4037cedf1da85efcd2b04d87469bcc (patch)
tree3c97950c2d124bd71b94119e20e93e66fec99754
parent51edacb5eb2c166f65d0950e36a00e09db5348ef (diff)
Add old release checklist
-rw-r--r--doc/release-checklist.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/release-checklist.md b/doc/release-checklist.md
new file mode 100644
index 00000000..6d27ab96
--- /dev/null
+++ b/doc/release-checklist.md
@@ -0,0 +1,27 @@
+Release checklist:
+
+- [ ] Check for outdated dependencies (`cargo outdated`)
+- [ ] Optional: update dependencies with `cargo update`.
+ See also https://deps.rs/repo/github/sharkdp/bat
+- [ ] Update syntaxes and themes (`cargo install -f --path .; assets/create.sh`).
+- [ ] Update README (features, usage, languages, ..).
+- [ ] Update man page
+
+
+- [ ] Update version in `Cargo.toml`. Run `cargo build` to update `Cargo.lock`
+- [ ] Update version in README and possibly update minimum Rust version
+- [ ] Run `cargo fmt`
+- [ ] Run `cargo test`
+- [ ] Run `cargo install --path . -f`
+- [ ] Test new features & command-line options
+- [ ] Check `-h` and `--help` texts
+
+
+- [ ] `cargo publish --dry-run --allow-dirty`.
+- [ ] write GitHub release notes
+- [ ] check if CI succeeds
+- [ ] `git tag vX.Y.Z; git push --tags`
+- [ ] check binaries (that were uploaded via Travis/AppVeyor)
+- [ ] publish to crates.io by cloning a fresh repo and calling `cargo publish`.
+- [ ] Inform package maintainers about the update:
+ - https://www.archlinux.org/packages/community/x86_64/bat/