@@ -35,26 +35,29 @@ See this page for a good overview: https://deps.rs/repo/github/sharkdp/bat
36## Pre-release checks
36## Pre-release checks
38−- [ ] Push all changes and wait for CI to succeed (before continuing with the next
38+- [ ] Push all changes and wait for CI to succeed (before continuing with the
39− section).
39+ next section).
40−- [ ] Optional: manually test the new features and command-line options. To do this,
40+- [ ] Optional: manually test the new features and command-line options. To do
41− install the latest `bat` version again (to include the new syntaxes/themes).
41+ this, install the latest `bat` version again (to include the new synaxes
42−- [ ] Run `cargo publish --dry-run --allow-dirty` to make sure that it will succeed
43+- [ ] Run `cargo publish --dry-run --allow-dirty` to make sure that it will
43− later (after creating the GitHub release).
44+ succeed later (after creating the GitHub release).
47- [ ] Create a tag and push it to the remote `git tag vX.Y.Z; git push --tags`.
48- [ ] Create a tag and push it to the remote `git tag vX.Y.Z; git push --tags`.
48 This will trigger the deployment via GitHub Actions.
49 This will trigger the deployment via GitHub Actions.
49−- [ ] Create a new release on GitHub: https://github.com/sharkdp/bat/releases/new
50+- [ ] Go to https://github.com/sharkdp/bat/releases/new to create the new
50− Select the new tag and also use it as the release title. Copy the
51+ release. Select the new tag and also use it as the release title. For the
51− corresponding section from `CHANGELOG.md` and possibly add remarks for
52+ release notes, copy the corresponding section from `CHANGELOG.md` and
53+ possibly add additional remarks for package maintainers.
52− package maintainers. Publish the release.
54+ Publish the release.
53- [ ] Check if the binary deployment works (archives and Debian packages should
55- [ ] Check if the binary deployment works (archives and Debian packages should
54 appear when the CI run for the Git tag has finished).
56 appear when the CI run for the Git tag has finished).
55−- [ ] Publish to crates.io by cloning *a fresh repository* and calling `cargo publish`.
57+- [ ] Publish to crates.io by running `cargo publish` in a *clean* repository.
58+ The safest way to do this is to cloning a fresh copy.
57## Post release
60## Post release
59−- [ ] Optional: inform package maintainers about the update:
62+- [ ] Optional: Inform package maintainers about the update:
60− - https://www.archlinux.org/packages/community/x86_64/bat/
63+ - https://www.archlinux.org/packages/community/x86_64/bat/