Commit Graph

17 Commits

Author SHA1 Message Date
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
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
Martin Nordholts 4789c71a37 release-checklist.md: Recommend looking at the tip of master for `-h` and `man` 2022-05-09 09:47:30 +02:00
Martin Nordholts be99b759d3 release-checklist.md: Recommend `--locked` for `cargo install`
So that the command will not fail if you are using the MSRV toolchain
and the latest version of a dependency happens to have a higher MSRV
than we do.
2022-05-09 09:47:30 +02:00
Martin Nordholts 5f7ae6b277 release-checklist.md: Recommend a single git grep command for MSRV
That filters out irrelevant hits in CHANGELOG.md and tests/.
2022-05-09 09:47:30 +02:00
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
Martin Nordholts 7be9485c36 release-checklist: Remind where to push tags in forks 2022-02-27 15:25:41 +01:00
Martin Nordholts 448bfaf748 Prepare a "unreleased" section at the top of `CHANGELOG.md` 2022-02-27 15:25:41 +01:00
Martin Nordholts 671fc952bc release-checklist.md: Add tip on how to review the man page 2022-02-27 07:39:22 +01:00
Martin Nordholts 8e8c350391 release-checklist.md: Remove '## Dependencies' 2022-02-26 17:08:32 +01:00
Martin Nordholts 743c4ccb17 doc/release-checklist.md: Tweak 2022-01-08 17:01:20 +01:00
Martin Nordholts 4236fa97cb release-checklist.md: Update `cargo outdated` section with link and arg 2021-12-03 09:17:32 +01:00
Martin Nordholts 12dfbdc400
doc/release-checklist.md: Recommend git push origin tag vX.Y.Z (#1815) 2021-08-23 20:08:04 +02:00
David Peter 11bd523f7e Remove post-release section 2021-08-22 09:38:35 +02:00
David Peter 01fbedc246 Formatting 2021-08-22 09:38:35 +02:00
David Peter 05e4e1f2f2 Add refined version of release checklist 2021-08-22 09:38:35 +02:00
David Peter 20223ad77c Add old release checklist 2021-08-22 09:38:35 +02:00