From 183e260e9b4286895d5185278beef2575e50db25 Mon Sep 17 00:00:00 2001 From: Frederic Cabassut Date: Mon, 14 Sep 2020 09:03:09 +0200 Subject: [PATCH] docs: mention default config fallback --- README.md | 2 ++ action.yml | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4ec8202..d845206 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,8 @@ The path to your commitlint config file. 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. + ### `firstParent` When set to true, we follow only the first parent commit when seeing a merge commit. diff --git a/action.yml b/action.yml index 7200788..f4e8d69 100644 --- a/action.yml +++ b/action.yml @@ -3,7 +3,7 @@ description: Lints Pull Request commit messages with commitlint author: Wagner Santos inputs: configFile: - description: Commitlint config file + description: Commitlint config file. If the file doesn't exist, config-conventional settings will be loaded as a fallback. default: ./commitlint.config.js required: false firstParent: