Skip to content

How to update cmd‐help after a bat release

Víctor González Prieto edited this page Jan 17, 2024 · 9 revisions

Whenever a new version of bat is released:

  • add a new tag to cmd-help (3m)

    GIT_COMMITTER_DATE="<datetime>" git tag -am "<msg>" <tag> <commit-SHA>`
    • on the latest commit of cmd-help that was included in the release
    • tag format like bat-v<x.y.z>
    • message like "Version of the syntax included with bat v<x.y.z>"
    • with the same date as their release but time 23:59:59 (GIT_COMMITTER_DATE)
  • update the bat & syntect versions used in tests (5-10m)

    • bump BAT_VERSION in tests/docker/bat-test.dockerfile

    • match SYNTECT_VERSION in tests/docker/syntest.dockerfile to the one in bat

    • remove the Docker image for syntest, so tests/syntax.py is forced to rebuild:

      docker image rm syntest
    • re-run all tests

      tests/highlight_regression.sh
      tests/theme_regression.sh
      tests/syntax.py
    • commit any changes

Clone this wiki locally