11
0
Fork 0
mirror of https://github.com/wagoid/commitlint-github-action.git synced 2026-04-04 16:56:52 +00:00

feat: upgrade to commitlint v19

BREAKING CHANGE: `commitlint.config.js` is not supported anymore, please use `.mjs` extension
This commit is contained in:
Wagner Santos 2024-03-28 11:38:50 -03:00
parent 9763196e10
commit 732f0ad7d5
24 changed files with 2431 additions and 13465 deletions

View file

@ -19,25 +19,27 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: wagoid/commitlint-github-action@v5
- uses: wagoid/commitlint-github-action@v6
```
Alternatively, you can run on other event types such as `on: [push]`. In that case the action will lint the push event's commit(s) instead of linting commits from a pull request. You can also combine `push` and `pull_request` together in the same workflow.
## Inputs
You can supply these inputs to the `wagoid/commitlint-github-action@v5` step.
You can supply these inputs to the `wagoid/commitlint-github-action@v6` step.
### `configFile`
The path to your commitlint config file.
Default: `commitlint.config.js`
Default: `commitlint.config.mjs`
If the config file doesn't exist, [config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional) settings will be loaded as a default fallback.
Details on the configuration file can be found on [the commitlint website](https://commitlint.js.org/#/reference-configuration).
Note: `commitlint.config.js` doesn't work with this action. If you use a JS config file, it's required to be an ES Module (`.mjs` extension)
### `failOnWarnings`
Whether you want to fail on warnings or not.
@ -149,7 +151,7 @@ jobs:
- run: npm install
# Run the commitlint action, considering its own dependencies and yours as well 🚀
# `github.workspace` is the path to your repository.
- uses: wagoid/commitlint-github-action@v5
- uses: wagoid/commitlint-github-action@v6
env:
NODE_PATH: ${{ github.workspace }}/node_modules
```