Create allowFailure input to mask the dreaded red X (#14)

* Add new allowFailure input

* Add allowFailure documentation

* Add if statement using allowFailure

* Update check conclusion

* Force variable to boolean

* Do not set output

* rebuild

---------

Co-authored-by: Brian Pohl <bpohl@getplunk.com>

README.md

@@ -7,6 +7,7 @@ Github Action to check if a PR's labels pass the specified rules
 - `hasNone`: Comma separated list of labels, PR must not have any of them
 - `hasNotAll`: Comma separated list of labels, PR must not have all of them
 - `githubToken`: GitHub token
+- `allowFailure`: When true, the action returns a successful exit code even if the label criteria are not met
 
 ## Output
 - `passed`: boolean

action.yml

@@ -16,6 +16,11 @@ inputs:
   githubToken:
     description: "The Github secret token to access PR check API"
     required: true
+  allowFailure:
+    description: 'When true, the action returns a successful exit code even if the label criteria are not met'
+    type: boolean
+    required: false
+    default: false
 outputs:
   passed:
     description: "Have the provided labels passed all tests?"

dist/index.cjs

@@ -10559,6 +10559,9 @@ async function run() {
     const hasNoneLabels = parseInputTags(hasNoneInput);
     const hasNotAllLabels = parseInputTags(hasNotAllInput);
 
+    const allowFailureInput = core.getInput("allowFailure");
+    const allowFailure = allowFailureInput === "true";
+
     const failMessages = [];
 
     const { data: labelsOnIssue } = await octokit.issues.listLabelsOnIssue({
@@ -10629,15 +10632,17 @@ async function run() {
         await octokit.checks.update({
           ...context.repo,
           check_run_id: id,
-          conclusion: "failure",
+          conclusion: allowFailure ? "success" : "failure",
           output: {
             title: "Labels did not pass provided rules",
             summary: failMessages.join(". "),
           },
         });
       }
 
-      core.setFailed(failMessages.join(". "));
+      if (!allowFailure) {
+        core.setFailed(failMessages.join(". "));
+      }
     } else {
       // update old checks
       for (const id of checkRunIds) {

index.cjs

@@ -23,6 +23,9 @@ async function run() {
     const hasNoneLabels = parseInputTags(hasNoneInput);
     const hasNotAllLabels = parseInputTags(hasNotAllInput);
 
+    const allowFailureInput = core.getInput("allowFailure");
+    const allowFailure = allowFailureInput === "true";
+
     const failMessages = [];
 
     const { data: labelsOnIssue } = await octokit.issues.listLabelsOnIssue({
@@ -93,15 +96,17 @@ async function run() {
         await octokit.checks.update({
           ...context.repo,
           check_run_id: id,
-          conclusion: "failure",
+          conclusion: allowFailure ? "success" : "failure",
           output: {
             title: "Labels did not pass provided rules",
             summary: failMessages.join(". "),
           },
         });
       }
 
-      core.setFailed(failMessages.join(". "));
+      if (!allowFailure) {
+        core.setFailed(failMessages.join(". "));
+      }
     } else {
       // update old checks
       for (const id of checkRunIds) {