fix: prevent duplicate runs for CodeRabbit plan trigger (hiero-ledger#1427) (hiero-ledger#1464)

Signed-off-by: cheese-cakee <farzanaman99@gmail.com>

Author: cheese-cakee

.github/scripts/coderabbit_plan_trigger.js

@@ -2,9 +2,14 @@
 
 const CODERABBIT_MARKER = '<!-- CodeRabbit Plan Trigger -->';
 
-async function triggerCodeRabbitPlan(github, owner, repo, issue, marker = CODERABBIT_MARKER) {
+async function triggerCodeRabbitPlan(github, owner, repo, issue, marker = CODERABBIT_MARKER, isDryRun = false) {
   const comment = `${marker} @coderabbitai plan`;
 
+  if (isDryRun) {
+    console.log(`[DRY RUN] Would trigger CodeRabbit plan for issue #${issue.number}`);
+    return true;
+  }
+
   try {
     await github.rest.issues.createComment({
       owner,
@@ -100,8 +105,11 @@ async function main({ github, context }) {
       return console.log(`CodeRabbit plan already triggered for #${issue.number}`);
     }
 
+    // Check for dry run (default to true if not specified, for safety)
+    const isDryRun = (process.env.DRY_RUN || 'true').toLowerCase() === 'true';
+
     // Post CodeRabbit plan trigger
-    await triggerCodeRabbitPlan(github, owner, repo, issue, CODERABBIT_MARKER);
+    await triggerCodeRabbitPlan(github, owner, repo, issue, CODERABBIT_MARKER, isDryRun);
 
     logSummary(owner, repo, issue);
   } catch (err) {

.github/workflows/bot-coderabbit-plan-trigger.yml

@@ -1,8 +1,20 @@
 # This workflow automatically triggers CodeRabbit's plan feature for intermediate and advanced issues.
+# Fix for #1427: Only triggers when a beginner/intermediate/advanced label is specifically added,
+# preventing duplicate runs when other labels are added to the same issue.
 name: CodeRabbit Plan Trigger
 on:
   issues:
-    types: [opened, labeled]
+    types: [labeled]
+  workflow_dispatch:
+    inputs:
+      dry_run:
+        description: "Run without posting comments"
+        required: false
+        default: "true"
+        type: choice
+        options:
+          - "true"
+          - "false"
 
 permissions:
   issues: write
@@ -14,17 +26,11 @@ jobs:
     concurrency:
       group: coderabbit-plan-${{ github.event.issue.number }}
       cancel-in-progress: false
-    # Only run for issues labeled with 'beginner', 'intermediate' or 'advanced' (case-insensitive)
+    # Only run when the newly added label is beginner, intermediate, or advanced (case-insensitive)
     if: >
-      (github.event_name == 'issues' && (
-        contains(github.event.issue.labels.*.name, 'intermediate') || 
-        contains(github.event.issue.labels.*.name, 'beginner') || 
-        contains(github.event.issue.labels.*.name, 'advanced') ||
-        contains(github.event.issue.labels.*.name, 'Intermediate') || 
-        contains(github.event.issue.labels.*.name, 'Beginner') || 
-        contains(github.event.issue.labels.*.name, 'Advanced') ||
-        (github.event.label && (github.event.label.name == 'intermediate' || github.event.label.name == 'advanced' || github.event.label.name == 'Intermediate' || github.event.label.name == 'Advanced' || github.event.label.name == 'beginner'|| github.event.label.name == 'Beginner'))
-      ))
+      github.event_name == 'workflow_dispatch' ||
+      (github.event.action == 'labeled' && 
+      contains(fromJson('["beginner","intermediate","advanced","Beginner","Intermediate","Advanced"]'), github.event.label.name))
 
     steps:
       - name: Harden the runner
@@ -36,8 +42,9 @@ jobs:
         uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 #v6.0.1
 
       - name: Trigger CodeRabbit Plan
-        env: 
+        env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DRY_RUN: ${{ github.event_name == 'workflow_dispatch' && inputs.dry_run || 'false' }}
         uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd #v8.0.0
         with:
           script: |

CHANGELOG.md

@@ -179,6 +179,7 @@ This changelog is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.
 - Enhance TopicInfo `__str__` method and tests with additional coverage, and update the format_key function in `key_format.py` to handle objects with a _to_proto method.
 
 ### Fixed
+- Fixed CodeRabbit plan trigger workflow running multiple times when issues are created with multiple labels by switching to labeled event trigger only. (#1427)
 - Prevent LinkBot from posting duplicate “missing linked issue” comments on pull requests. (#1475)
 - Refined intermediate assignment guard to validate Beginner issue completion with improved logging and GraphQL-based counting. (#1424)
 - Improved filename-related error handling with clearer and more descriptive error messages.(#1413)