-
Notifications
You must be signed in to change notification settings - Fork 5
How to manually bump cmd‐help version in bat's submodules
In the bat project, we use a sample test messsage to test cmd-help for regression.
We also track that sample (bat-short-0.22.1) in this project: source, highlighted.
If the highlighted version changes while running tests (and we merge into main), we have to propagate that change to bat.
That's because, normally, cmd-help.sublime-syntax is automatically updated by bat's Dependabot setup. (example)
But when the regression test message changes, we break the tests there and the Dependabot update won't proceed. (example)
So we have to update the highlighting of that message in bat and make a PR:
-
Clone the
batrepository andcdin -
Update the submodule to latest:
git submodule update --remote assets/syntaxes/02_Extra/cmd-help
-
Build a
batbinary with modified syntaxes and themes:bash assets/create.sh cargo install --path . --locked --force -
Run syntax highlighting regression tests to update the highlighted version of the test:
tests/syntax_tests/update.sh
-
Update the Changelog in their style
-
Commit everything together
-
Make a PR (example)
After that, to recover the custom bat syntaxes & themes for our bat installation:
bat cache --buildReferences:
contributions to this wiki are welcome! :D
if cmd-help is useful to you, please give it a star ⭐