mirror of https://github.com/sharkdp/bat synced 2024-11-30 07:40:24 +00:00

Martin Nordholts dc7d5a862f release-checklist.md: Don't recommend --allow-dirty to cargo publish

Using `--allow-dirty` increases the risk of the published code not being
versioned properly in git.

2022-05-09 09:47:30 +02:00

Release checklist

Version bump

Update version in Cargo.toml. Run cargo build to update Cargo.lock. Make sure to git add the Cargo.lock changes as well.
Find the current min. supported Rust version by running grep '^\s*MIN_SUPPORTED_RUST_VERSION' .github/workflows/CICD.yml.
Update the version and the min. supported Rust version in README.md and doc/README-*.md. Check with git grep -i -e 'rust.*1\.' -e '1\..*rust' | grep README | grep -v tests/.
Update CHANGELOG.md. Introduce a section for the new release.

Install the latest master version (cargo clean && cargo install --locked -f --path .) and make sure that it is available on the PATH (bat --version should show the new version).
Run assets/create.sh and check in the binary asset files.

Review -h, --help, and the man page. All of these are shown in the output of the CI job called Documentation, so look there. The CI workflow corresponding to the tip of the master branch is a good place to look.

Push all changes and wait for CI to succeed (before continuing with the next section).
Optional: manually test the new features and command-line options. To do this, install the latest bat version again (to include the new syntaxes and themes).
Run cargo publish --dry-run to make sure that it will succeed later (after creating the GitHub release).

Create a tag and push it: git tag vX.Y.Z; git push origin tag vX.Y.Z. This will trigger the deployment via GitHub Actions. REMINDER: If your origin is a fork, don't forget to push to e.g. upstream instead!
Go to https://github.com/sharkdp/bat/releases/new to create the new release. Select the new tag and also use it as the release title. For the release notes, copy the corresponding section from CHANGELOG.md and possibly add additional remarks for package maintainers. Publish the release.
Check if the binary deployment works (archives and Debian packages should appear when the CI run for the Git tag has finished).
Publish to crates.io by running cargo publish in a clean repository. The safest way to do this is to clone a fresh copy.

Prepare a new "unreleased" section at the top of CHANGELOG.md. Put this at the top:

# unreleased

## Features

## Bugfixes

## Other

## Syntaxes

## Themes

## `bat` as a library