git - commit msg for checks

https://github.com/nntrn/save/issues/6

Created on Last updated on


When a repository is set to automatically request checks for pushes, you can choose to skip checks for an individual commit you push. When a repository is not set to automatically request checks for pushes, you can request checks for an individual commit you push.

To skip or request checks for your commit, add one of the following trailer lines to the end of your commit message:

  • To skip checks for a commit, type your commit message and a short, meaningful description of your changes. After your commit description, before the closing quotation, add two empty lines followed by skip-checks: true:
    $ git commit -m "Update README
    >
    >
    skip-checks: true"
    
  • To request checks for a commit, type your commit message and a short, meaningful description of your changes. After your commit description, before the closing quotation, add two empty lines followed by request-checks: true:
    $ git commit -m "Refactor usability tests
    >
    >
    request-checks: true"
    

Source: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks#skipping-and-requesting-checks-for-individual-commits