Skip to content

Commit

Permalink
docs: removes commitDepth Info from readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Sakethtadimeti committed Nov 24, 2022
1 parent b0982e3 commit 1e32deb
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
4 changes: 0 additions & 4 deletions README.md
Expand Up @@ -150,10 +150,6 @@ jobs:
# Run the commitlint action, considering its own dependencies and yours as well 🚀
# `github.workspace` is the path to your repository.
- uses: wagoid/commitlint-github-action@v5
# Optinally, add a commitDepth parameter
# This example would only consider the last 10 commits.
with:
commitDepth: 10
env:
NODE_PATH: ${{ github.workspace }}/node_modules
```
Expand Down
11 changes: 8 additions & 3 deletions action.yml
Expand Up @@ -3,7 +3,8 @@ 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
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
Expand All @@ -12,16 +13,20 @@ inputs:
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"
default: 'true'
required: false
failOnWarnings:
description: Whether you want to fail on warnings or not
default: "false"
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
commitDepth:
description: When set to a valid Integer value - X, considers only the latest X number of commits.
default: ''
required: false
token:
description: >
Personal access token (PAT) used to interact with the GitHub API. By default, the
Expand Down

0 comments on commit 1e32deb

Please sign in to comment.