Walkthrough

Added configurable bot user list and multi-marker bot-detection across Gatekeeper, CommandHandler, and response generation; injected a hidden HTML marker into triage summaries to reliably identify bot-generated comments and prevent self-triggered processing loops.

Changes

Sequence Diagram(s)

sequenceDiagram
    participant Event as Incoming Event\n(issue_comment / pr_comment)
    participant Gate as Gatekeeper
    participant Config as Config
    participant Handler as CommandHandler
    participant Builder as ResponseBuilder

    Event->>Gate: Deliver event with author + body
    activate Gate
    Gate->>Config: Read BotUsers
    Gate->>Gate: isBotAuthor(author, BotUsers)?
    alt bot author
        Gate-->>Event: Log and skip event
    else not bot
        Gate-->>Handler: Forward event
    end
    deactivate Gate

    activate Handler
    Handler->>Handler: isBotComment(body)?
    alt bot comment
        Handler-->>Event: Log and skip processing
    else user comment
        Handler->>Handler: Process commands (e.g., /undo)
        Handler->>Handler: Scan history using isBotComment to find prior transfers
        Handler->>Builder: Build any response
    end
    deactivate Handler

    activate Builder
    Builder->>Builder: buildTriageSummary()
    Builder->>Builder: Prepend <!-- simili-bot-report --> then visible header
    Builder-->>Event: Post response (contains hidden marker)
    deactivate Builder

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

• fix: prevent infinite bot comment loop #62: Implements the same set of changes (Config.BotUsers, isBotComment/isBotAuthor helpers, hidden HTML marker, and unified pr_comment handling) and appears directly related.

Poem

🐰 I hid a note where humans peep,
a tiny mark to guard my sleep.
Bot names listed, loops undone,
now comments stop when chores are done.
Hooray — no endless chat, just hops and fun! 🥕✨

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

• 📝 Generate docstrings

• Missing explicit numbered reproduction steps
• No specific environment details
• Add a dedicated 'Steps to Reproduce' section, even if it's just 'Run the bot on an issue/PR'
• Include details about the bot's deployment environment or relevant GitHub platform version

• No direct link to an example issue/PR where the loop occurred
• No mention of the specific GitHub Actions workflow file that runs the bot
• Add a link to an example issue/PR affected by the infinite loop
• Specify the GitHub Actions workflow file name (e.g., '.github/workflows/simili-triage.yml')

• No explicit environment details
• Specify the bot's deployment environment or version if relevant

• Missing specific environment details
• No direct link to an example occurrence
• Specify the GitHub environment (e.g., Cloud, Enterprise)
• Provide a link to an issue/PR where this behavior was observed

• Missing explicit reproduction steps
• Missing environment details
• Add explicit reproduction steps for clarity (e.g., 'Trigger bot by X')
• Specify environment details (e.g., GitHub platform, runner OS/version)

• No explicit step-by-step reproduction guide
• Missing specific environment details (e.g., bot version, specific repository/workflow)
• For future bug reports, include explicit steps to reproduce the issue if applicable
• Specify the exact environment (e.g., bot version, GitHub Actions runner version, repository context) where the issue was observed

• Missing specific links to affected GitHub issues/PRs
• Missing explicit environment details
• Include links to specific issues/PRs where the loop was observed
• Specify the bot's operating environment (e.g., GitHub.com, GitHub Enterprise version)

• No direct links to affected issues/PRs demonstrating the loop
• Environment details (e.g., specific workflow name) are implied but not explicitly stated
• Add links to one or more issues/PRs where the infinite loop was observed
• Explicitly mention the GitHub Actions workflow (e.g., 'simili-triage.yml') where this bot runs

• Missing specific environment details
• Explicit step-by-step reproduction instructions are not provided
• Specify the exact environment where the bot is deployed and the loop was observed (e.g., GitHub Actions runner version, specific repository context)
• Optionally, include a link to an example issue/PR where the infinite loop occurred

• Missing specific bot version or deployment environment details
• No direct link to an example issue/PR where the loop occurred
• Specify the bot version or deployment environment (e.g., GitHub Cloud, Enterprise) where this bug was observed.
• If possible, include a link to an issue or pull request where the infinite loop manifested.

• Consider adding a link to an example issue/PR where this behavior was observed for additional context.
• While not strictly necessary for this type of logic bug, explicitly stating the GitHub Actions runner environment (e.g., 'ubuntu-latest') could be a minor completeness improvement.

• Missing specific bot version
• No explicit GitHub Actions runner environment details
• Specify the bot version where the bug was observed
• Mention the GitHub Actions runner environment (e.g., ubuntu-latest)

• No direct link to an example of the infinite loop occurring
• No specific environment details (e.g., bot version, GitHub Actions runner version)
• Add a link to an issue or PR where the bot exhibited the infinite loop behavior
• Specify the bot version or the GitHub Actions environment details where this bug was observed

• No direct link to an affected issue/PR where the loop occurred
• Bot version not explicitly stated
• Provide a link to an example issue or PR demonstrating the infinite loop
• Mention the specific version of the bot that exhibited this behavior

• No explicit environment details (e.g., bot version, specific GitHub instance if applicable)
• Consider including specific environment details if the bot operates in varied setups, though less critical for this logic bug

• No specific environment details (e.g., bot version, specific workflow run ID where the loop occurred)
• No raw error logs provided (though the root cause explanation is very thorough)
• For future bug reports, include specific environment details or links to affected runs/repositories
• For future bug reports, provide relevant log snippets if available

• Missing specific bot version
• Missing GitHub environment details
• Specify the bot version if relevant
• Indicate if the issue occurred on GitHub.com or GitHub Enterprise

• Lacks explicit, numbered reproduction steps
• No specific environment details (e.g., bot version, runtime environment)
• Add a simple, explicit reproduction step for clarity, even if implied
• Include relevant environment context, such as the bot version or GitHub Actions runner details

• No explicit environment details
• No raw error logs provided
• Consider adding environment details if relevant (e.g., GitHub Actions runner type)
• If applicable, include specific log snippets or links to workflow runs exhibiting the behavior

• No explicit environment details
• Specify the environment where the bot runs (e.g., GitHub Actions runner version, self-hosted vs. cloud) if there are variations that could impact the fix.

• No direct link to an affected issue/PR demonstrating the loop
• No specific examples (e.g., screenshots or text snippets) of the 20+ duplicate comments
• Provide a link to an example issue/PR where the infinite loop occurred
• Include a snippet or screenshot of the duplicate comments for visual confirmation

• No explicit reproduction steps
• Missing specific environment details
• Add explicit reproduction steps for future bug reports
• Include relevant environment details (e.g., GitHub Actions runner version, language runtime) if applicable

• Missing explicit environment details (e.g., bot version, GitHub environment)
• No specific error logs (though the problem is a logical loop, not a crash)
• Specify the bot version or deployment environment if relevant
• If any logs did show the repeated actions, include snippets

• No explicit environment details (e.g., GitHub Actions runner version)
• No direct error logs (though the problematic comments serve as the error manifestation)
• If relevant, specify the environment where the bot runs (e.g., GitHub Actions runner version)
• If any internal logs were generated before the infinite loop, mentioning them could add value

• No explicit step-by-step reproduction instructions
• Lack of specific environment details (e.g., workflow run IDs, specific repository context if not obvious)
• Provide explicit reproduction steps (e.g., 'Trigger the bot by X, observe Y')
• Include any relevant environment details that could aid debugging or context

• Implicit reproduction steps (could be more explicit)
• Missing specific bot version or action run details
• No link to an example occurrence (if applicable)
• Add a dedicated 'Steps to Reproduce' section, even if simple
• Include the bot's version or the GitHub Action run ID where the issue was observed
• Provide a link to an issue/PR where the infinite loop occurred, if publicly accessible

• Missing explicit environment details (e.g., bot version, specific GitHub setup)
• Add specific bot version or deployment environment details if relevant for future debugging or context

• No explicit environment details
• Consider adding specific environment details (e.g., GitHub Actions runner OS/version) if relevant for debugging.

• Bot version not specified
• Include the specific bot version or deployment context if known

• Missing explicit environment details
• No direct error logs provided
• Include details about the GitHub environment (e.g., GitHub.com, GHE version) if relevant
• If available, add relevant log snippets that show the bot's incorrect behavior or related errors, although the root cause is very well explained here

• Missing explicit reproduction steps
• Missing environment details (e.g., bot version, GitHub Actions runner)
• While the root cause explains the bug's manifestation, adding formal 'Steps to Reproduce' could further enhance completeness.
• Specify any relevant environment details, such as the bot's deployed version or the GitHub Actions runner environment where the loop occurred.

• No explicit reproduction steps (though root cause is clear)
• Missing specific bot version or deployment environment details
• Consider adding explicit steps to observe the infinite loop before the fix (if easily reproducible)
• Specify the bot version or the environment where this issue was observed

• No direct links to relevant code files
• Add direct links to the mentioned code files (e.g., response_builder.go) for quick navigation

• Missing specific bot version or GitHub Actions runner details
• Include the bot's version and relevant GitHub Actions runner environment details

• No explicit environment details
• Reproduction steps are implicit
• Add explicit environment details (e.g., GitHub Actions runner OS)
• Provide explicit step-by-step reproduction instructions for clarity

• Missing a direct link to an example issue/PR demonstrating the infinite loop
• Environment details (e.g., specific GitHub Action runner, bot version) are not explicitly stated
• Include a link to an affected GitHub issue or PR for direct observation of the bug
• Specify the operational environment of the bot (e.g., GitHub Action runner OS, bot version)

• Missing explicit reproduction steps
• No specific environment details
• Add explicit steps to reproduce the infinite loop
• Specify bot version and GitHub Actions runner environment