Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: resolve ambiguities #158

Merged
merged 2 commits into from May 19, 2021
Merged

docs: resolve ambiguities #158

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4874b95
docs: link to more information on configurations
austanss May 18, 2021
203ccfe
docs: specify how to supply inputs
austanss May 18, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
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