From 0a78530f89a561977392045fd15f54d0c65554a5 Mon Sep 17 00:00:00 2001 From: km-anthropic Date: Fri, 1 Aug 2025 15:47:53 -0700 Subject: [PATCH] docs: clarify agent mode only works with workflow_dispatch and schedule events (#378) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * docs: clarify agent mode only works with workflow_dispatch and schedule events Updates documentation to match the current implementation where agent mode is restricted to workflow_dispatch and schedule events only. This addresses the confusion reported in issues #364 and #376. Changes: - Updated README to clearly state agent mode limitations - Added explicit note that agent mode does NOT work with PR/issue events - Updated example workflows to only show supported event types - Updated CLAUDE.md internal documentation Fixes #364 Fixes #376 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude * minor formatting update * update agent mode docs --------- Co-authored-by: km-anthropic Co-authored-by: Claude --- CLAUDE.md | 4 ++-- README.md | 33 +++++++++++++++++++++++---------- examples/claude-modes.yml | 30 +++++++++++++++--------------- 3 files changed, 40 insertions(+), 27 deletions(-) diff --git a/CLAUDE.md b/CLAUDE.md index d9c5e64..061e731 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -53,7 +53,7 @@ Execution steps: #### Mode System (`src/modes/`) - **Tag Mode** (`tag/`): Responds to `@claude` mentions and issue assignments -- **Agent Mode** (`agent/`): Automated execution without trigger checking +- **Agent Mode** (`agent/`): Automated execution for workflow_dispatch and schedule events only - Extensible registry pattern in `modes/registry.ts` #### GitHub Integration (`src/github/`) @@ -118,7 +118,7 @@ src/ - Modes implement `Mode` interface with `shouldTrigger()` and `prepare()` methods - Registry validates mode compatibility with GitHub event types -- Agent mode bypasses all trigger checking for automation scenarios +- Agent mode only works with workflow_dispatch and schedule events ### Comment Threading diff --git a/README.md b/README.md index 1e6ed68..a682264 100644 --- a/README.md +++ b/README.md @@ -223,19 +223,32 @@ The traditional implementation mode that responds to @claude mentions, issue ass ### Agent Mode -For automation and scheduled tasks without trigger checking. +**Note: Agent mode is currently in active development and may undergo breaking changes.** -- **Triggers**: Always runs (no trigger checking) -- **Features**: Perfect for scheduled tasks, works with `override_prompt` -- **Use case**: Maintenance tasks, automated reporting, scheduled checks +For automation with workflow_dis`patch and scheduled events only. + +- **Triggers**: Only runs on `workflow_dispatch` and `schedule` events +- **Features**: Bypasses mention/assignment checking for automation scenarios +- **Use case**: Manual workflow runs, scheduled maintenance tasks, cron jobs +- **Note**: Does NOT work with `pull_request`, `issues`, or `issue_comment` events ```yaml -- uses: anthropics/claude-code-action@beta - with: - mode: agent - anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }} - override_prompt: | - Check for outdated dependencies and create an issue if any are found. +# Example with workflow_dispatch +on: + workflow_dispatch: + schedule: + - cron: "0 0 * * 0" # Weekly on Sunday + +jobs: + automated-task: + runs-on: ubuntu-latest + steps: + - uses: anthropics/claude-code-action@beta + with: + mode: agent + anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }} + override_prompt: | + Check for outdated dependencies and create an issue if any are found. ``` ### Experimental Review Mode diff --git a/examples/claude-modes.yml b/examples/claude-modes.yml index 5809e24..4d1033e 100644 --- a/examples/claude-modes.yml +++ b/examples/claude-modes.yml @@ -1,13 +1,17 @@ name: Claude Mode Examples on: - # Common events for both modes + # Events for tag mode issue_comment: types: [created] issues: types: [opened, labeled] pull_request: types: [opened] + # Events for agent mode (only these work with agent mode) + workflow_dispatch: + schedule: + - cron: "0 0 * * 0" # Weekly on Sunday jobs: # Tag Mode (Default) - Traditional implementation @@ -28,13 +32,12 @@ jobs: # - Creates tracking comments with progress checkboxes # - Perfect for: Interactive Q&A, on-demand code changes - # Agent Mode - Automation without triggers - agent-mode-auto-review: - # Automatically review every new PR - if: github.event_name == 'pull_request' && github.event.action == 'opened' + # Agent Mode - Automation for workflow_dispatch and schedule events + agent-mode-scheduled-task: + # Only works with workflow_dispatch or schedule events runs-on: ubuntu-latest permissions: - contents: read + contents: write pull-requests: write issues: write id-token: write @@ -44,13 +47,10 @@ jobs: mode: agent anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }} override_prompt: | - Review this PR for code quality. Focus on: - - Potential bugs or logic errors - - Security concerns - - Performance issues - - Provide specific, actionable feedback. + Check for outdated dependencies and security vulnerabilities. + Create an issue if any critical problems are found. # Agent mode behavior: - # - NO @claude mention needed - runs immediately - # - Enables true automation (impossible with tag mode) - # - Perfect for: CI/CD integration, automatic reviews, label-based workflows + # - ONLY works with workflow_dispatch and schedule events + # - Does NOT work with pull_request, issues, or issue_comment events + # - No @claude mention needed for supported events + # - Perfect for: scheduled maintenance, manual automation runs