actions/commitlint-github-action
13
0
Fork 0
mirror of https://github.com/wagoid/commitlint-github-action.git synced 2026-07-01 16:19:31 +00:00
Code Activity Actions

docs(action): fix input and output descriptions in action.yml

Browse source
This commit is contained in:
Kranthi Poturaju 2026-04-30 00:53:56 +05:30
parent b948419dd9
commit 920bde4559
No known key found for this signature in database
1 changed files with 12 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

17
action.yml
View file

@ -3,8 +3,9 @@ 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: >
loaded as a fallback. Commitlint config file. The .js extension is not supported; use .mjs instead.
If the file doesn't exist, config-conventional settings will be loaded as a fallback.
default: ./commitlint.config.mjs default: ./commitlint.config.mjs
required: false required: false
failOnWarnings: failOnWarnings:
@ -14,13 +15,15 @@ inputs:
failOnErrors: failOnErrors:
description: Whether you want to fail on errors or not description: Whether you want to fail on errors or not
default: "true" default: "true"
required: true required: false
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 an integer value X, considers only the first X commits from the returned commit list.
Values less than or equal to zero, or values that cannot be parsed as an integer, are ignored and all commits are linted.
default: "" default: ""
required: false required: false
token: token:
@ -32,7 +35,11 @@ inputs:
required: false required: false
outputs: outputs:
results: results:
description: The error and warning messages for each one of the analyzed commits description: >
JSON-encoded string representing an array of lint results for each analyzed
commit; parse it with fromJSON in workflows. Each entry contains:
hash (commit SHA), message (commit message), valid (boolean),
errors (array of strings), warnings (array of strings).
runs: runs:
using: docker using: docker
image: docker://wagoid/commitlint-github-action:6.2.1 image: docker://wagoid/commitlint-github-action:6.2.1