actions/commitlint-github-action
5
0
Fork 0
mirror of https://github.com/wagoid/commitlint-github-action.git synced 2025-11-07 16:06:56 +00:00
Code Activity Actions

Merge pull request #158 from rizet/master

Browse source 
docs: resolve ambiguities
This commit is contained in:
Wagner Santos 2021-05-19 06:30:28 -03:00 committed by GitHub
commit cdbc702428
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -26,6 +26,8 @@ Alternatively, you can run on other event types such as `on: [push]`. In that ca
## Inputs ## Inputs
You can supply these inputs to the `wagoid/commitlint-github-action@v3` step.
### `configFile` ### `configFile`
The path to your commitlint config file. The path to your commitlint config file.
@ -34,6 +36,8 @@ Default: `commitlint.config.js`
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. 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).
### `firstParent` ### `firstParent`
When set to true, we follow only the first parent commit when seeing a merge commit. When set to true, we follow only the first parent commit when seeing a merge commit.