feat: add configuration for enabling status comments in GitHub project

Author: tanhongit

config/github-project.php

@@ -11,4 +11,6 @@
         'access_token' => env('GITHUB_ACCESS_TOKEN', ''),
         'graphql_url' => env('GITHUB_GRAPHQL_URL', 'https://api.github.com/graphql'),
     ],
+
+    'enable_status_comment' => env('GITHUB_PROJECT_ENABLE_STATUS_COMMENT', false),
 ];

lang/en/github-project.php

@@ -10,6 +10,7 @@
             'denied' => 'The event was denied.',
             'action_not_found' => 'Not an action event.',
             'missing_fields' => 'Missing required fields.',
+            'status_comment_disabled' => 'Status comment is disabled.',
         ],
     ],
 

src/Services/WebhookService.php

@@ -37,6 +37,13 @@ public function validatePayload(array $payload): ?JsonResponse
         if (!isset($payload['action'])) {
             return response()->json(
                 ['message' => __('github-project::github-project.error.event.action_not_found')],
+                404
+            );
+        }
+
+        if (!$this->isStatusCommentEnabled($payload['changes']['field_value']['field_name'])) {
+            return response()->json(
+                ['message' => __('github-project::github-project.error.event.status_comment_disabled')],
                 400
             );
         }
@@ -54,6 +61,22 @@ public function validatePayload(array $payload): ?JsonResponse
         return null;
     }
 
+    /**
+     * Check if the field name is "Status" and if status comments are enabled.
+     *
+     * @param  string  $fieldName
+     *
+     * @return bool
+     */
+    public function isStatusCommentEnabled(string $fieldName): bool
+    {
+        if ($fieldName === 'Status' && !config('github-project.enable_status_comment')) {
+            return false;
+        }
+
+        return true;
+    }
+
     /**
      * @param  string  $contentNodeId
      * @param  string  $message