mirror of
https://github.com/wagoid/commitlint-github-action.git
synced 2025-11-09 08:46:54 +00:00
2c2244784a
Make Docker repository URL configurable to allow clients to choose different repository URL for the action, in case they don't have access to changing Docker configuration on their runners.
44 lines
1.7 KiB
YAML
44 lines
1.7 KiB
YAML
name: Commit Linter
|
|
description: Lints Pull Request commit messages with commitlint
|
|
author: Wagner Santos
|
|
inputs:
|
|
configFile:
|
|
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:
|
|
description: >
|
|
When set to true, we follow only the first parent commit when seeing a merge commit. More info
|
|
in git-log docs https://git-scm.com/docs/git-log#Documentation/git-log.txt---first-parent
|
|
default: 'true'
|
|
required: false
|
|
failOnWarnings:
|
|
description: Whether you want to fail on warnings or not
|
|
default: 'false'
|
|
required: false
|
|
helpURL:
|
|
description: Link to a page explaining your commit message convention
|
|
default: https://github.com/conventional-changelog/commitlint/#what-is-commitlint
|
|
required: false
|
|
token:
|
|
description: >
|
|
Personal access token (PAT) used to interact with the GitHub API. By default, the automatic
|
|
token provided by GitHub is used. You can see more info about GitHub's default token here:
|
|
https://docs.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token
|
|
default: ${{ github.token }}
|
|
required: false
|
|
dockerRepoURL:
|
|
description: Docker repository URL to be used by the action. Useful when using a private repository mirror instead of public Docker Hub.
|
|
default: docker://wagoid/commitlint-github-action
|
|
required: false
|
|
outputs:
|
|
results:
|
|
description: The error and warning messages for each one of the analyzed commits
|
|
runs:
|
|
using: docker
|
|
image: '${{ inputs.dockerRepoURL }}:4.1.10'
|
|
branding:
|
|
icon: check-square
|
|
color: blue
|