extern/bat
1
0
Fork 0
mirror of https://github.com/sharkdp/bat.git synced 2024-11-25 17:23:39 +01:00
Code Issues Packages Projects Releases Wiki Activity
7334ab4542
bat/doc/release-checklist.md
Martin Nordholts 719248f1c1
Simplify release-checklist.md by printing -h, --help and man in CI (#2183) 
* Simplify release-checklist.md by printing `-h`, `--help` and `man` in CI

Note that we run `find . -name bat.1` before we run anything with
`--all-features`, because `--all-features` is considered a separate
target, and so we will get a different (but identical) `bat.1`. For
example, we might have these:

    ./target/debug/build/bat-218e9538b4996215/out/assets/manual/bat.1
    ./target/debug/build/bat-89d6f56802af023f/out/assets/manual/bat.1

By showing the man page earlier, there is only one `bat.1` to pick from.

* Use plain `man $(find . -name bat.1)`
2022-05-06 07:33:32 +02:00

2.5 KiB
Raw Blame History

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 'rust.*1\.' and git grep -i '1\..*rust'.
  • Update CHANGELOG.md. Introduce a section for the new release.

Update syntaxes and themes (build assets)

  • Install the latest master version (cargo clean && cargo install -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.

Documentation

  • Review -h, --help, and the man page. All of these are shown in the output of the CI job called Documentation, so look there.

Pre-release checks

  • 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 --allow-dirty to make sure that it will succeed later (after creating the GitHub release).

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.

Post-release

  • 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