5
0
Fork 0
mirror of https://github.com/wagoid/commitlint-github-action.git synced 2025-11-07 16:06:56 +00:00

fix(action): add field to action

This commit is contained in:
Cooper 2023-04-07 11:30:10 -04:00
parent 6a9739b9a2
commit 8589bb7e04
No known key found for this signature in database
GPG key ID: DF6ECEF0888ECA4B

View file

@ -3,7 +3,8 @@ description: Lints Pull Request commit messages with commitlint
author: Wagner Santos author: Wagner Santos
inputs: inputs:
configFile: configFile:
description: Commitlint config file. If the file doesn't exist, config-conventional settings will be description:
Commitlint config file. If the file doesn't exist, config-conventional settings will be
loaded as a fallback. loaded as a fallback.
default: ./commitlint.config.js default: ./commitlint.config.js
required: false required: false
@ -12,19 +13,23 @@ inputs:
When set to true, we follow only the first parent commit when seeing a merge commit. When set to true, we follow only the first parent commit when seeing a merge commit.
More info in git-log docs More info in git-log docs
https://git-scm.com/docs/git-log#Documentation/git-log.txt---first-parent https://git-scm.com/docs/git-log#Documentation/git-log.txt---first-parent
default: "true" default: 'true'
required: false required: false
failOnWarnings: failOnWarnings:
description: Whether you want to fail on warnings or not description: Whether you want to fail on warnings or not
default: "false" default: 'false'
required: false required: false
failOnErrors:
description: Whether you want to fail on errors or not
default: 'true'
required: true
helpURL: helpURL:
description: Link to a page explaining your commit message convention description: Link to a page explaining your commit message convention
default: https://github.com/conventional-changelog/commitlint/#what-is-commitlint default: https://github.com/conventional-changelog/commitlint/#what-is-commitlint
required: false required: false
commitDepth: commitDepth:
description: When set to a valid Integer value - X, considers only the latest X number of commits. description: When set to a valid Integer value - X, considers only the latest X number of commits.
default: "" default: ''
required: false required: false
token: token:
description: > description: >