feat: add error-if-missing (#14)

* add a flag to error if missing

* ran prettier

---------

Co-authored-by: Luke Lalor <[email protected]>

Author: nicgrayson

README.md

@@ -29,6 +29,7 @@ jobs:
 | username | Obtained from the context by default, can also be customized to pass in | string | ✖ |
 | check-bot | Check whether the user is a bot | boolean | ✖ |
 | check-contributor | Check whether the user is contributor | boolean | ✖ |
+| error-if-missing | Error if require or check if false | boolean | ✖ |
 
 - User permission: `admin` > `write` > `read`
 - `username` support [github context](https://docs.github.com/en/actions/learn-github-actions/contexts#github-context)

src/main.js

@@ -50,30 +50,38 @@ async function run() {
       return contributors;
     }
 
-    if (checkBot == 'true') {
+    if (checkBot === 'true') {
       const { data } = await octokit.users.getByUsername({
         username,
       });
       if (data.type === 'Bot') {
         checkResult = true;
       }
-    } else if (checkContributor == 'true') {
+    } else if (checkContributor === 'true') {
       let contributors = await queryContributors();
       contributors = contributors.map(({ login }) => login);
       if (contributors.length) {
         checkResult = contributors.includes(username);
       }
     }
 
+    checkFailed = false;
     if (checkBot || checkContributor) {
       core.info(`[Action Check] The check result is ${checkResult}.`);
       core.setOutput('check-result', checkResult);
+      checkFailed = checkFailed || !checkResult;
     }
 
     if (require) {
       requireResult = checkPermission(require, permission);
       core.info(`[Action Require] The ${username} permission check is ${requireResult}.`);
       core.setOutput('require-result', requireResult);
+      checkFailed = checkFailed || !requireResult;
+    }
+
+    const errorIfMissing = core.getInput('error-if-missing');
+    if (checkFailed && errorIfMissing === 'true') {
+      core.setFailed('The required check failed.');
     }
 
     core.info(THANKS);