Tool to make sure your commits are compliant with conventional commits. It is aimed mainly at CIs to prevent branches with commits that don't comply. Usage as a pre-commit hook is also under consideration.
Please check Documentation.
Important: Commitsar currently needs to be run in the same folder as the git repository you want checked, currently no override is provided for setting path to git repo see aevea#93
Checkout git in order to get commits and master branch
- name: Check out code into the Go module directory
uses: actions/checkout@v1
Run the Commitsar action
- name: Commitsar Action
uses: docker://outillage/commitsar
validate-commits:
docker:
- image: outillage/commitsar
steps:
- checkout
- run: commitsar
Adjust for version and distribution. Please check Releases.
- curl -L -O https://github.com/outillage/commitsar/releases/download/v0.0.2/commitsar_v0.0.2_Linux_x86_64.tar.gz
- tar -xzf commitsar_v0.0.2_Linux_x86_64.tar.gz
- ./commitsar
Commitsar allows the following flags:
| Name | Flag | Required | Default | Description |
|---|---|---|---|---|
| Verbose | --v | false | false | Debug output into console |
| Strict | --s | false | true | Strict check of category types |
| All | --all | false | false | Whether to check all commits on given branch. Takes precedence over LIMIT flag |
On top of that a single argument is allowed:
commitsar <from commit>...<to commit>
e.g. commitsar 7dbf3e7db93ae2e02902cae9d2f1de1b1e5c8c92...d0240d3ed34685d0a5329b185e120d3e8c205be4
If only one commit hash is used then commitsar will assume it to be the TO commit.