extern/bat
1
0
Fork 0
mirror of https://github.com/sharkdp/bat.git synced 2024-11-23 16:23:43 +01:00
Code Issues Packages Projects Releases Wiki Activity
231ad86f04
bat/doc/release-checklist.md
Martin Nordholts 4e34b362f8 Require changes to -h and --help to be blessed 
From now on, any changes to the help texts will be visible in PR diffs,
which will make it very easy to review, and very hard to accidentally
miss changes to help texts.

If a contributor makes a change to help texts, the `cargo test` failure
text they will see contains instructions on how to update the blessed
help texts:

    error: expect test failed
       --> ../doc/long-help.txt

    You can update all `expect!` tests by running:

        env UPDATE_EXPECT=1 cargo test

In short, to update blessed help texts, one simply does

    env UPDATE_EXPECT=1 cargo test

Do not run the tests if the `git` feature is missing, since then
`--diff` will be missing from `--help`. And do not run the tests on
Windows, because then the help text will contain the term `.exe`.

Move man page step to after cargo doc step so that the man page exists
when we look for it.
2022-12-30 09:59:52 +01:00

2.6 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 -e 'rust.*1\.' -e '1\..*rust' | grep README | grep -v tests/.
  • 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 --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.

Documentation

  • Review -h, --help, and the man page. The man page is 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.

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 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