diff --git a/README.md b/README.md index 16c8a2b..050b3cc 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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.