mirror of
https://github.com/anthropics/claude-code-action.git
synced 2026-01-22 22:44:13 +08:00
docs: clarify agent mode only works with workflow_dispatch and schedule events (#378)
* 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 <noreply@anthropic.com> * minor formatting update * update agent mode docs --------- Co-authored-by: km-anthropic <km-anthropic@users.noreply.github.com> Co-authored-by: Claude <noreply@anthropic.com>
This commit is contained in:
33
README.md
33
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
|
||||
|
||||
Reference in New Issue
Block a user