Merge pull request #7 from mainmatter/fix-branch-build

Ignore action run events other than pull requests

Author: mansona

README.md

@@ -16,9 +16,8 @@ Considering you have the following `.github/workflow` file:
 name: CI
 
 on:
-  push:
-    branches:
-      - main
+  # NOTE: continue-on-error-comment only makes sense to run on a Pull Request
+  # see below for more information
   pull_request: {}
 
 jobs:
@@ -60,6 +59,12 @@ and then you add a step after that one that uses this action making sure that yo
 
 Test-id is used to identify which test failed, so make sure that you pass the relevant `matrix` variables so that you can identify it later.
 
+### Pull Request Context
+
+`continue-on-error-comment` is designed to be used in the context of a Pull Request. It doesn't make much sense to run this on a commit on a branch.
+
+If you do end up adding this action in a non-PR context then it is designed to just do nothing and continue without error. If you find that isn't true please open a bug report with reproduction instructions and we will fix the problem.
+
 ## Inputs
 
 ### `repo-token`

dist/index.js

@@ -9586,53 +9586,57 @@ __nccwpck_require__.a(__webpack_module__, async (__webpack_handle_async_dependen
 
 
 
-try {
-  const myToken = (0,_actions_core__WEBPACK_IMPORTED_MODULE_0__.getInput)('repo-token', { required: true });
-  const outcome = (0,_actions_core__WEBPACK_IMPORTED_MODULE_0__.getInput)('outcome', { required: true });
-  const testId = (0,_actions_core__WEBPACK_IMPORTED_MODULE_0__.getInput)('test-id', { required: true });
-
-  if (outcome === 'failure') {
-    const octokit = (0,_actions_github__WEBPACK_IMPORTED_MODULE_1__.getOctokit)(myToken);
-    const pullRequest = await (0,_lib_get_pull_request_js__WEBPACK_IMPORTED_MODULE_2__/* ["default"] */ .Z)(_actions_github__WEBPACK_IMPORTED_MODULE_1__.context, octokit);
-  
-    const { data: comments } = await octokit.rest.issues.listComments({
-      owner: _actions_github__WEBPACK_IMPORTED_MODULE_1__.context.repo.owner,
-      repo: _actions_github__WEBPACK_IMPORTED_MODULE_1__.context.repo.repo,
-      issue_number: pullRequest.number,
-    });
-
-    const existingComment = comments.find((comment) => comment.user.login === 'github-actions[bot]' && comment.body.endsWith(_lib_constants_js__WEBPACK_IMPORTED_MODULE_3__/* .signiture */ .o) && comment.body.includes(`sha: ${_actions_github__WEBPACK_IMPORTED_MODULE_1__.context.sha}`));
-  
-    if (existingComment) {
-
-      let body = existingComment.body.split('\n');
-
-      body.splice(body.length - 3, 0, `- ${testId}`);
-
-      await octokit.rest.issues.updateComment({
-        owner: _actions_github__WEBPACK_IMPORTED_MODULE_1__.context.repo.owner,
-        repo: _actions_github__WEBPACK_IMPORTED_MODULE_1__.context.repo.repo,
-        comment_id: existingComment.id,
-        body: body.join('\n'),
-      });
-    } else {
-      const body = `Some tests with 'continue-on-error: true' have failed: 
-  
-- ${testId}
-
-sha: ${_actions_github__WEBPACK_IMPORTED_MODULE_1__.context.sha}
-${_lib_constants_js__WEBPACK_IMPORTED_MODULE_3__/* .signiture */ .o}`;
-      await octokit.rest.issues.createComment({
+if(_actions_github__WEBPACK_IMPORTED_MODULE_1__.context.eventName !== 'pull_request') {
+  console.log(`continue-on-error-comment is designed to be used with pull request and does not work with a [${_actions_github__WEBPACK_IMPORTED_MODULE_1__.context.eventName}] event. We are ignoring this event.`);
+} else {
+  try {
+    const myToken = (0,_actions_core__WEBPACK_IMPORTED_MODULE_0__.getInput)('repo-token', { required: true });
+    const outcome = (0,_actions_core__WEBPACK_IMPORTED_MODULE_0__.getInput)('outcome', { required: true });
+    const testId = (0,_actions_core__WEBPACK_IMPORTED_MODULE_0__.getInput)('test-id', { required: true });
+
+    if (outcome === 'failure') {
+      const octokit = (0,_actions_github__WEBPACK_IMPORTED_MODULE_1__.getOctokit)(myToken);
+      const pullRequest = await (0,_lib_get_pull_request_js__WEBPACK_IMPORTED_MODULE_2__/* ["default"] */ .Z)(_actions_github__WEBPACK_IMPORTED_MODULE_1__.context, octokit);
+    
+      const { data: comments } = await octokit.rest.issues.listComments({
         owner: _actions_github__WEBPACK_IMPORTED_MODULE_1__.context.repo.owner,
         repo: _actions_github__WEBPACK_IMPORTED_MODULE_1__.context.repo.repo,
         issue_number: pullRequest.number,
-        body,
       });
+
+      const existingComment = comments.find((comment) => comment.user.login === 'github-actions[bot]' && comment.body.endsWith(_lib_constants_js__WEBPACK_IMPORTED_MODULE_3__/* .signiture */ .o) && comment.body.includes(`sha: ${_actions_github__WEBPACK_IMPORTED_MODULE_1__.context.sha}`));
+    
+      if (existingComment) {
+
+        let body = existingComment.body.split('\n');
+
+        body.splice(body.length - 3, 0, `- ${testId}`);
+
+        await octokit.rest.issues.updateComment({
+          owner: _actions_github__WEBPACK_IMPORTED_MODULE_1__.context.repo.owner,
+          repo: _actions_github__WEBPACK_IMPORTED_MODULE_1__.context.repo.repo,
+          comment_id: existingComment.id,
+          body: body.join('\n'),
+        });
+      } else {
+        const body = `Some tests with 'continue-on-error: true' have failed: 
+    
+  - ${testId}
+
+  sha: ${_actions_github__WEBPACK_IMPORTED_MODULE_1__.context.sha}
+  ${_lib_constants_js__WEBPACK_IMPORTED_MODULE_3__/* .signiture */ .o}`;
+        await octokit.rest.issues.createComment({
+          owner: _actions_github__WEBPACK_IMPORTED_MODULE_1__.context.repo.owner,
+          repo: _actions_github__WEBPACK_IMPORTED_MODULE_1__.context.repo.repo,
+          issue_number: pullRequest.number,
+          body,
+        });
+      }
     }
-  }
 
-} catch (error) {
-  (0,_actions_core__WEBPACK_IMPORTED_MODULE_0__.setFailed)(error.message);
+  } catch (error) {
+    (0,_actions_core__WEBPACK_IMPORTED_MODULE_0__.setFailed)(error.message);
+  }
 }
 __webpack_handle_async_dependencies__();
 }, 1);

index.js

@@ -5,51 +5,55 @@ import getPullRequest from './lib/get-pull-request.js';
 
 import { signiture } from './lib/constants.js';
 
-try {
-  const myToken = getInput('repo-token', { required: true });
-  const outcome = getInput('outcome', { required: true });
-  const testId = getInput('test-id', { required: true });
-
-  if (outcome === 'failure') {
-    const octokit = getOctokit(myToken);
-    const pullRequest = await getPullRequest(context, octokit);
-  
-    const { data: comments } = await octokit.rest.issues.listComments({
-      owner: context.repo.owner,
-      repo: context.repo.repo,
-      issue_number: pullRequest.number,
-    });
-
-    const existingComment = comments.find((comment) => comment.user.login === 'github-actions[bot]' && comment.body.endsWith(signiture) && comment.body.includes(`sha: ${context.sha}`));
-  
-    if (existingComment) {
-
-      let body = existingComment.body.split('\n');
-
-      body.splice(body.length - 3, 0, `- ${testId}`);
-
-      await octokit.rest.issues.updateComment({
-        owner: context.repo.owner,
-        repo: context.repo.repo,
-        comment_id: existingComment.id,
-        body: body.join('\n'),
-      });
-    } else {
-      const body = `Some tests with 'continue-on-error: true' have failed: 
-  
-- ${testId}
-
-sha: ${context.sha}
-${signiture}`;
-      await octokit.rest.issues.createComment({
+if(context.eventName !== 'pull_request') {
+  console.log(`continue-on-error-comment is designed to be used with pull request and does not work with a [${context.eventName}] event. We are ignoring this event.`);
+} else {
+  try {
+    const myToken = getInput('repo-token', { required: true });
+    const outcome = getInput('outcome', { required: true });
+    const testId = getInput('test-id', { required: true });
+
+    if (outcome === 'failure') {
+      const octokit = getOctokit(myToken);
+      const pullRequest = await getPullRequest(context, octokit);
+    
+      const { data: comments } = await octokit.rest.issues.listComments({
         owner: context.repo.owner,
         repo: context.repo.repo,
         issue_number: pullRequest.number,
-        body,
       });
+
+      const existingComment = comments.find((comment) => comment.user.login === 'github-actions[bot]' && comment.body.endsWith(signiture) && comment.body.includes(`sha: ${context.sha}`));
+    
+      if (existingComment) {
+
+        let body = existingComment.body.split('\n');
+
+        body.splice(body.length - 3, 0, `- ${testId}`);
+
+        await octokit.rest.issues.updateComment({
+          owner: context.repo.owner,
+          repo: context.repo.repo,
+          comment_id: existingComment.id,
+          body: body.join('\n'),
+        });
+      } else {
+        const body = `Some tests with 'continue-on-error: true' have failed: 
+    
+  - ${testId}
+
+  sha: ${context.sha}
+  ${signiture}`;
+        await octokit.rest.issues.createComment({
+          owner: context.repo.owner,
+          repo: context.repo.repo,
+          issue_number: pullRequest.number,
+          body,
+        });
+      }
     }
-  }
 
-} catch (error) {
-  setFailed(error.message);
+  } catch (error) {
+    setFailed(error.message);
+  }
 }

pre-dist/index.js

@@ -9647,7 +9647,7 @@ try {
 
 } catch (error) {
   // we want to ignore any failure at this stage but we will log it in case we need to debug something
-  console.log(error.message);
+  console.log(`Error during pre-run step: [${error.message}]`);
 }
 __webpack_handle_async_dependencies__();
 }, 1);

pre.js

@@ -31,5 +31,5 @@ try {
 
 } catch (error) {
   // we want to ignore any failure at this stage but we will log it in case we need to debug something
-  console.log(error.message);
+  console.log(`Error during pre-run step: [${error.message}]`);
 }