actions/commitlint-github-action
11
0
Fork 0
mirror of https://github.com/wagoid/commitlint-github-action.git synced 2026-04-05 09:06:54 +00:00
Code Activity Actions

feat: add helpURL parameter

Browse source
This commit is contained in:
Wagner Santos 2020-02-01 16:49:21 -03:00
parent 73133a4495
commit f4821d1c76
4 changed files with 18 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -38,8 +38,7 @@ Default: `commitlint.config.js`
When set to true, we follow only the first parent commit when seeing a merge commit.
This helps to ignore errors in commits that were already present in your default branch (e.g. `master`) before adding conventional commit checks.
More info in [git-log docs](https://git-scm.com/docs/git-log#Documentation/git-log.txt---first-parent).
This helps to ignore errors in commits that were already present in your default branch (e.g. `master`) before adding conventional commit checks. More info in [git-log docs](https://git-scm.com/docs/git-log#Documentation/git-log.txt---first-parent).
Default: `true`
@ -49,6 +48,12 @@ Whether you want to fail on warnings or not.
Default: `false`
### `helpURL`
Link to a page explaining your commit message convention.
default: `https://github.com/conventional-changelog/commitlint/#what-is-commitlint`
## About `extends` in your config file
This is a [`Docker` action](https://github.com/actions/toolkit/blob/e2adf403d6d14a9ca7474976ccaca20f72ff8209/docs/action-types.md#why-would-i-choose-a-docker-action), and was made like this so that you can run it with minimum setup, regardless of your repo's environment. It comes packed with the most famous shared configurations that you can use in your commitlint config's `extends` field: