fix(action): refactor a value, add to docs

README.md

@@ -52,6 +52,18 @@ Whether you want to fail on warnings or not.
 
 Default: `false`
 
+### `failOnWarnings`
+
+Whether you want to fail on warnings or not.
+
+Default: `false`
+
+### `failOnErrors`
+
+Whether you want to fail on errors or not. Still outputs the results, just forces the action to pass even if errors are detected.
+
+Default: `true`
+
 ### `helpURL`
 
 Link to a page explaining your commit message convention.

src/action.js

@@ -16,8 +16,6 @@ const { GITHUB_EVENT_NAME, GITHUB_SHA } = process.env
 
 const configPath = resolve(process.env.GITHUB_WORKSPACE, getInput('configFile'))
 
-const failOnErrors = getInput('failOnErrors')
-
 const getCommitDepth = () => {
   const commitDepthString = getInput('commitDepth')
   if (!commitDepthString?.trim()) return null
@@ -147,7 +145,7 @@ const showLintResults = async ([from, to]) => {
 
   if (hasOnlyWarnings(lintedCommits)) {
     handleOnlyWarnings(formattedResults)
-  } else if (formattedResults && failOnErrors === 'false') {
+  } else if (formattedResults && getInput('failOnErrors') === 'false') {
     // https://github.com/actions/toolkit/tree/master/packages/core#exit-codes
     // this would be a good place to implement the setNeutral() when it's eventually implimented.
     // for now it can pass with a check mark.