Commit Graph

164 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
David Peter
b29f66c40d
Merge branch 'master' into feat/env-extension 2022-10-30 20:45:39 +01:00
Ville Skyttä
6378a95308 Add more dotenv file types
Upstream PR: https://github.com/zaynali53/DotENV/pull/17
2022-10-30 08:25:10 +02:00
Wu Zhenyu
46dc044c03 Add new file_extensions for INI
- https://coverage.readthedocs.io/en/6.3.2/faq.html#q-can-i-find-out-which-tests-ran-which-lines
- https://pylint.pycqa.org/en/latest/user_guide/usage/run.html#command-line-options
- https://jorisroovers.com/gitlint/configuration/
2022-10-30 13:15:14 +08:00
Ville Skyttä
21bdcbb71f Fix up punctuation and sorting in manual modifications doc 2022-10-17 19:50:14 +02:00
Masanori Kakura
16d181a755 ja: Update description about Debian/Ubuntu packages 2022-10-03 21:41:36 +02:00
Jon Eskin
eab1c9eb46 update alternatives.md 2022-09-04 14:28:06 +02:00
David Peter
45d6b1af3b Bump MSRV to 1.60
see https://github.com/rust-lang/git2-rs/issues/838
2022-09-04 06:04:35 +02:00
David Peter
02a9d191ed Bump MSRV to 1.58 2022-08-14 16:21:45 +02:00
Martin Nordholts
ab8f97b0bb Bump MSRV to 1.56.1
This is what `hashbrown` did recently: https://github.com/rust-lang/hashbrown/pull/298

And it causes CI failures for us. Examples:
* https://github.com/sharkdp/bat/pull/2266
* https://github.com/sharkdp/bat/pull/2265

The path of least resistance for us is to also bump MSRV, so let's do
that. 1.56.1 was released [9 months
ago](https://blog.rust-lang.org/2021/11/01/Rust-1.56.1.html).
2022-08-13 14:10:19 +02:00
Kian-Meng Ang
f93d650708 Fix typos 2022-06-12 16:38:33 +02: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
yuuji.yaginuma
36093dd3bc Fix a repology badge in READMEs
`https://repology.org/project/bat/` doesn't exist now.
2022-02-26 13:54:02 +01:00
David Peter
f2166ec6ec
Add additional note to sponsors.md 2022-02-09 21:57:52 +01:00
Keith Hall
478712be38 make further improvements to docs relating to sponsors 2022-02-09 21:54:32 +01:00
Keith Hall
d5d2fc4016 create separate sponsors.md file 2022-02-09 21:54:32 +01:00
Keith Hall
f340893a21 Add WorkOS sponsor to readme 2022-02-09 21:54:32 +01:00
klemens
9287cf6b0b small typos, should not interrupt anything 2022-01-09 12:59:01 +01:00
Martin Nordholts
53fb0baa06 doc/README-ja.md: Update MSRV 2022-01-08 17:01:20 +01:00
Martin Nordholts
743c4ccb17 doc/release-checklist.md: Tweak 2022-01-08 17:01:20 +01:00
Mahdi Dibaiee
6dc621ec18 Set minimum supported rust version to 1.51 2021-12-30 07:58:15 +01:00
D3ara1n
a5234105e5
Add a README-zh.md as the Chinese version of README.md (#1970)
Add README-zh.md to replace the outdated one. Also fix url ref.
2021-12-05 20:18:38 +01:00
Martin Nordholts
4236fa97cb release-checklist.md: Update cargo outdated section with link and arg 2021-12-03 09:17:32 +01:00
David Peter
1822c981da Move comparison.sh benchmark script to documentation 2021-11-23 08:14:49 +01:00
i-ky
aed4ea144f
Sync README header across translations (#1905)
* Fix links in Russian translation.
* Simplify links in Korean translation.
* Fix build status badge in Japanese and Russian translations.
* Add link from Japanese to Russian translation.
* Add line break between "topics" row and "translations" row.
* Remove "translations" from translations row in Japanese and Russian.
* Add consistent spacing between translation links.
* Add backreferences to English README.
* Remove self references.
* Split translations row across multiple lines for easier maintenance.

Co-authored-by: David Peter <sharkdp@users.noreply.github.com>
2021-10-17 21:15:23 +02:00
Ikko Ashimine
10288e309e Add Русский link 2021-10-17 20:44:15 +02:00
mac.mini
ebdb00d4fc add security vulnerabilities in ko doc 2021-10-16 21:05:02 +02:00
USER
8f6a0cd9e2 update Korean readme 2021-10-10 10:24:04 +02:00
Martin Nordholts
418fce5683 Bump MSRV to 1.46
See #1874 and #1872.
2021-10-03 07:51:37 +02:00
Kevin John Mulligan
156dec2737 Add context to .ino configuration
This allows a user to search the README or the entire repository for "Arduino" to find the necessary configuration.
2021-09-07 20:21:12 +02: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
Martin Nordholts
b3247d9364 Merge the v0.18.3 hotfix release into master
The v0.18.3 release was a hotfix release to make bat build again with Rust 1.54.
This merge commit brings in all changes from the hotfix release into the master
branch.

In practice, this only brings in one new commit, namely b146958ec. The other
three commits in the release were cherry-picks from master.
2021-08-22 19:22:20 +02:00
Martin Nordholts
b146958ecb Bump version to v0.18.3 2021-08-22 17:47:12 +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
a1346054
51edacb5eb style: trim excess whitespace 2021-08-21 23:07:37 +02:00
Ville Skyttä
43e1a11ad8 Make Package Control reference a link 2021-08-19 07:21:32 +02:00
Keith Hall
6d5ff671e7 Add HTTP Request/Response syntax as a git submodule 2021-07-29 21:36:16 +02:00
David Peter
a4b674902f Bump version to v0.18.2 2021-07-12 23:17:48 +02:00
Ryooooooga
07d4179274 ja: add section about integration with fzf
ref: c569774e1a
2021-05-24 22:12:43 +02:00