feat: add commit linter #13
Conversation
* uses https://github.com/conventional-changelog/commitlint to lint commit messages
| uses: actions/checkout@v4 | ||
|
|
||
| - name: commitlint | ||
| uses: wagoid/commitlint-github-action@v6 |
There was a problem hiding this comment.
minor: for 3rd-party action (i.e. those that are not under the "official" actions/ namespace), I prefer that we reference them by their commit hash with the intedned tag/version in a comment
There was a problem hiding this comment.
To be clear, using the commit hash is for security + breaking change shield purposes, right? As in, we use v6 and a rogue action update to 6.1 introduces a vulnerability or breaks the CI? (must admit that for our own repos and at least docs-invenio-rdm I haven't been that paranoid )
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: commitlint |
There was a problem hiding this comment.
I'm not sure what the default config is for commitlint, but I see there are many of flexible options and even "shared configurations" (similar to ESLint).
I would prefer that we have a "global" config with the set of allowed types (i.e. chore, feat, fix, etc.). Regarding topics (i.e. whatever goes in fix(<topic>): ...) I see that we:
- have a set of global topics
- repo-specific topics where applicable via their own
.commitlintrc?
3 participants
commit messages
https://www.conventionalcommits.org/en/v1.0.0/