Skip to content

Commit

Permalink
Merge pull request #158 from rizet/master
Browse files Browse the repository at this point in the history
docs: resolve ambiguities
  • Loading branch information
wagoid committed May 19, 2021
2 parents a23ae3c + 203ccfe commit cdbc702
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Expand Up @@ -26,6 +26,8 @@ Alternatively, you can run on other event types such as `on: [push]`. In that ca

## Inputs

You can supply these inputs to the `wagoid/commitlint-github-action@v3` step.

### `configFile`

The path to your commitlint config file.
Expand All @@ -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.

Details on the configuration file can be found on [the commitlint website](https://commitlint.js.org/#/reference-configuration).

### `firstParent`

When set to true, we follow only the first parent commit when seeing a merge commit.
Expand Down

0 comments on commit cdbc702

Please sign in to comment.