Skip to content

Commit 5607a8e

Browse files
docs(action): fix input and output descriptions in action.yml
1 parent b948419 commit 5607a8e

1 file changed

Lines changed: 12 additions & 5 deletions

File tree

action.yml

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@ description: Lints Pull Request commit messages with commitlint
33
author: Wagner Santos
44
inputs:
55
configFile:
6-
description: Commitlint config file. If the file doesn't exist, config-conventional settings will be
7-
loaded as a fallback.
6+
description: >
7+
Commitlint config file. The .js extension is not supported; use .mjs instead.
8+
If the file doesn't exist, config-conventional settings will be loaded as a fallback.
89
default: ./commitlint.config.mjs
910
required: false
1011
failOnWarnings:
@@ -14,13 +15,15 @@ inputs:
1415
failOnErrors:
1516
description: Whether you want to fail on errors or not
1617
default: "true"
17-
required: true
18+
required: false
1819
helpURL:
1920
description: Link to a page explaining your commit message convention
2021
default: https://github.com/conventional-changelog/commitlint/#what-is-commitlint
2122
required: false
2223
commitDepth:
23-
description: When set to a valid Integer value - X, considers only the latest X number of commits.
24+
description: >
25+
When set to an integer value X, considers only the latest X number of commits.
26+
Values less than or equal to zero, or values that cannot be parsed as an integer, are ignored and all commits are linted.
2427
default: ""
2528
required: false
2629
token:
@@ -32,7 +35,11 @@ inputs:
3235
required: false
3336
outputs:
3437
results:
35-
description: The error and warning messages for each one of the analyzed commits
38+
description: >
39+
JSON-encoded string representing an array of lint results for each analyzed
40+
commit; parse it with fromJson in workflows. Each entry contains:
41+
hash (commit SHA), message (commit message), valid (boolean),
42+
errors (array of strings), warnings (array of strings).
3643
runs:
3744
using: docker
3845
image: docker://wagoid/commitlint-github-action:6.2.1

0 commit comments

Comments
 (0)