From 1e32deb6dd2fe3bad9b0a2810e7c4759946b3783 Mon Sep 17 00:00:00 2001
From: Sakethtadimeti <saketh.4445@gmail.com>
Date: Thu, 24 Nov 2022 16:58:02 +0530
Subject: [PATCH] docs: removes commitDepth Info from readme

---
 README.md  |  4 ----
 action.yml | 11 ++++++++---
 2 files changed, 8 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 711a856b..1aa3e9ee 100644
--- a/README.md
+++ b/README.md
@@ -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
 ```
diff --git a/action.yml b/action.yml
index 9b6435e5..c61a0ca0 100644
--- a/action.yml
+++ b/action.yml
@@ -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
@@ -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