actions/commitlint-github-action
5
0
Fork 0
mirror of https://github.com/wagoid/commitlint-github-action.git synced 2025-11-07 08:06:54 +00:00
Code Activity Actions

docs: removes commitDepth Info from readme

Browse source
This commit is contained in:
Sakethtadimeti 2022-11-24 16:58:02 +05:30
parent b0982e3b0a
commit 1e32deb6dd
2 changed files with 8 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -150,10 +150,6 @@ jobs:
# Run the commitlint action, considering its own dependencies and yours as well 🚀 # Run the commitlint action, considering its own dependencies and yours as well 🚀
# `github.workspace` is the path to your repository. # `github.workspace` is the path to your repository.
- uses: wagoid/commitlint-github-action@v5 - uses: wagoid/commitlint-github-action@v5
# Optinally, add a commitDepth parameter
# This example would only consider the last 10 commits.
with:
commitDepth: 10
env: env:
NODE_PATH: ${{ github.workspace }}/node_modules NODE_PATH: ${{ github.workspace }}/node_modules
``` ```

11
action.yml
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,16 +13,20 @@ 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
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:
description: When set to a valid Integer value - X, considers only the latest X number of commits.
default: ''
required: false
token: token:
description: > description: >
Personal access token (PAT) used to interact with the GitHub API. By default, the Personal access token (PAT) used to interact with the GitHub API. By default, the