From 4874b9585896b2f93d883d8bb2490d46dd205f49 Mon Sep 17 00:00:00 2001 From: rizet <63219214+rizet@users.noreply.github.com> Date: Tue, 18 May 2021 18:47:19 -0400 Subject: [PATCH 1/2] docs: link to more information on configurations --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 16c8a2bb..c4f3ae28 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,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. From 203ccfe5a4efb526045d5b0a1a01b0216a00c94b Mon Sep 17 00:00:00 2001 From: rizet <63219214+rizet@users.noreply.github.com> Date: Tue, 18 May 2021 18:45:27 -0400 Subject: [PATCH 2/2] docs: specify how to supply inputs --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index c4f3ae28..050b3cc4 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.