Explain misconfigured workflow (#405)

Fixes #136
actions · Jun 19, 2023 · b5ff161 · b5ff161
1 parent fe87e60
commit b5ff161
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 10 deletions.
diff --git a/dist/index.js b/dist/index.js
@@ -76,11 +76,25 @@ function run() {
                     labelsToRemove.push(label);
                 }
             }
-            if (labels.length > 0) {
-                yield addLabels(client, prNumber, labels);
+            try {
+                if (labels.length > 0) {
+                    yield addLabels(client, prNumber, labels);
+                }
+                if (syncLabels && labelsToRemove.length) {
+                    yield removeLabels(client, prNumber, labelsToRemove);
+                }
             }
-            if (syncLabels && labelsToRemove.length) {
-                yield removeLabels(client, prNumber, labelsToRemove);
+            catch (error) {
+                if (error.name === 'HttpError' &&
+                    error.message === 'Resource not accessible by integration') {
+                    core.warning(`The action requires write permission to add labels to pull requests. For more information please refer to the action documentation: https://github.com/actions/labeler#permissions`, {
+                        title: `${process.env['GITHUB_ACTION_REPOSITORY']} running under '${github.context.eventName}' is misconfigured`
+                    });
+                    core.setFailed(error.message);
+                }
+                else {
+                    throw error;
+                }
             }
         }
         catch (error) {

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "labeler",
-  "version": "4.0.1",
+  "version": "4.1.0",
   "description": "Labels pull requests by files altered",
   "main": "lib/main.js",
   "scripts": {

diff --git a/src/labeler.ts b/src/labeler.ts
@@ -50,12 +50,29 @@ export async function run() {
       }
     }
 
-    if (labels.length > 0) {
-      await addLabels(client, prNumber, labels);
-    }
+    try {
+      if (labels.length > 0) {
+        await addLabels(client, prNumber, labels);
+      }
 
-    if (syncLabels && labelsToRemove.length) {
-      await removeLabels(client, prNumber, labelsToRemove);
+      if (syncLabels && labelsToRemove.length) {
+        await removeLabels(client, prNumber, labelsToRemove);
+      }
+    } catch (error: any) {
+      if (
+        error.name === 'HttpError' &&
+        error.message === 'Resource not accessible by integration'
+      ) {
+        core.warning(
+          `The action requires write permission to add labels to pull requests. For more information please refer to the action documentation: https://github.com/actions/labeler#permissions`,
+          {
+            title: `${process.env['GITHUB_ACTION_REPOSITORY']} running under '${github.context.eventName}' is misconfigured`
+          }
+        );
+        core.setFailed(error.message);
+      } else {
+        throw error;
+      }
     }
   } catch (error: any) {
     core.error(error);