doc: document input check-mentions

redhat-plumbers-in-action · Nov 27, 2024 · bd71493 · bd71493
1 parent fef592f
commit bd71493
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -137,6 +137,7 @@ Action currently accepts the following options:
 
 - uses: redhat-plumbers-in-action/regression-sniffer@v1
   with:
+    check-mentions:   <boolean>
     check-follow-up:  <boolean>
     check-revert:     <boolean>
     pr-metadata:      <pr-metadata.json>
@@ -147,6 +148,13 @@ Action currently accepts the following options:
 # ...
 ```
 
+### check-mentions
+
+Check if Pull Request has some commit mentions related to cherri-picked commits in upstream available.
+
+* default value: `true`
+* requirements: `optional`
+
 ### check-follow-up
 
 Check if Pull Request has some follow-up commit related to cherri-picked commits in upstream available.