Robot
/
bat
mirror of https://github.com/sharkdp/bat.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Formatting

This commit is contained in:
David Peter 2021-08-21 23:01:29 +02:00 committed by David Peter
parent 05e4e1f2f2
commit 01fbedc246
1 changed files with 16 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
doc/release-checklist.md
View File

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