diff options
| author | Martin Nordholts <enselic@gmail.com> | 2022-05-06 07:33:32 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-05-06 07:33:32 +0200 |
| commit | 719248f1c1a2c1c6723b941d3a58cafccf6e3739 (patch) | |
| tree | 0e7b8c0b2c9afd6aad945b73e495f7c9ec84a966 | |
| parent | ef3e398b2b76d8e6103cbd96aa715740c7809d10 (diff) | |
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)`
| -rw-r--r-- | .github/workflows/CICD.yml | 12 | ||||
| -rw-r--r-- | doc/release-checklist.md | 4 |
2 files changed, 14 insertions, 2 deletions
diff --git a/.github/workflows/CICD.yml b/.github/workflows/CICD.yml index 124c7e31..dc1fcbcb 100644 --- a/.github/workflows/CICD.yml +++ b/.github/workflows/CICD.yml @@ -118,6 +118,18 @@ jobs: toolchain: stable default: true profile: minimal + - name: Print -h + uses: actions-rs/cargo@v1 + with: + command: run + args: --locked -- -h + - name: Print --help + uses: actions-rs/cargo@v1 + with: + command: run + args: --locked -- --help + - name: Show man page + run: man $(find . -name bat.1) - name: Check documentation env: RUSTDOCFLAGS: -D warnings diff --git a/doc/release-checklist.md b/doc/release-checklist.md index 26cd4839..c3ebaaea 100644 --- a/doc/release-checklist.md +++ b/doc/release-checklist.md @@ -20,8 +20,8 @@ ## Documentation -- [ ] Review the `-h` and `--help` texts -- [ ] Review the `man` page (`man $(fd -HIp target/release/build.*out/assets/manual/bat.1) | tee`) +- [ ] 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 |