Exit with exit code 0 when event is not pull_request or pull_request_target (#3)

Author: nilsreichardt

README.md

@@ -30,6 +30,12 @@ GitHub Action.
 ## Usage
 
 ```yaml
+on:
+  # This action only works with pull_request and pull_request_target events.
+  # 
+  # For other events, it succeeds with exit code 0.
+  pull_request: # or pull_request_target
+
 jobs:
   analyze:
     runs-on: ubuntu-latest

index.js

@@ -5,9 +5,10 @@ async function run() {
     try {
         const context = github.context;
 
-        const allowedEvents = ['pull_request', 'pull_request_target', 'merge_group'];
-        if (allowedEvents.indexOf(context.eventName) === -1) {
-            core.setFailed(`This action only works with the following events: ${allowedEvents.join(', ')}.`);
+        const allowedEvents = ['pull_request', 'pull_request_target'];
+        const isNotAllowedEvent = allowedEvents.indexOf(context.eventName) === -1;
+        if (isNotAllowedEvent) {
+            console.log(`Event "${context.eventName}", skipping. This action only works with the following events: ${allowedEvents.join(', ')}.`);
             return;
         }
 

index.test.js

@@ -106,7 +106,7 @@ describe('verify-safe-to-test-label', () => {
         expect(core.setFailed).toHaveBeenCalledTimes(0);
     });
 
-    test('should fail when eventName is not allowed', async () => {
+    test('should skip when eventName is not allowed', async () => {
         const payload = {
             pull_request: {
                 head: {
@@ -133,9 +133,8 @@ describe('verify-safe-to-test-label', () => {
 
         await run();
 
-        expect(core.setFailed).toHaveBeenCalledWith(
-            `This action only works with the following events: pull_request, pull_request_target, merge_group.`
-        );
+        expect(core.setFailed).toHaveBeenCalledTimes(0);
+        expect(github.getOctokit).toHaveBeenCalledTimes(0);
     });
 
     test('should fail when there is an error', async () => {