mirror of
https://github.com/anthropics/claude-code-action.git
synced 2026-01-22 22:44:13 +08:00
docs: Update documentation for v1.0 release (#476)
* docs: Update documentation for v1.0 release - Integrate breaking changes naturally without alarming users - Replace deprecated inputs (direct_prompt, custom_instructions, mode) with new unified approach - Update all examples to use prompt and claude_args instead of deprecated inputs - Add migration guides to help users transition from v0.x to v1.0 - Emphasize automatic mode detection as a key feature - Update all workflow examples to @v1 from @beta - Document how claude_args provides direct CLI control - Update FAQ with automatic mode detection explanation - Convert all tool configuration to use claude_args format * fix: Apply prettier formatting to documentation files * fix: Update all Claude model versions to latest and improve documentation accuracy - Update all model references to claude-4-0-sonnet-20250805 (latest Sonnet 4) - Update Bedrock models to anthropic.claude-4-0-sonnet-20250805-v1:0 - Update Vertex models to claude-4-0-sonnet@20250805 - Fix cloud-providers.md to use claude_args instead of deprecated model input - Ensure all examples use @v1 instead of @beta - Keep claude-opus-4-1-20250805 in examples where Opus is demonstrated - Align all documentation with v1.0 patterns consistently * feat: Add dedicated migration guide as requested in PR feedback - Create comprehensive migration-guide.md with step-by-step instructions - Add prominent links to migration guide in README.md - Update usage.md to reference the separate migration guide - Include before/after examples for all common scenarios - Add checklist for systematic migration - Address Ashwin's feedback about having a separate, clearly linked migration guide
This commit is contained in:
@@ -1,21 +1,21 @@
|
||||
name: Claude Mode Examples
|
||||
name: Claude Automatic Mode Detection Examples
|
||||
|
||||
on:
|
||||
# Events for tag mode
|
||||
# Events for interactive mode (responds to @claude mentions)
|
||||
issue_comment:
|
||||
types: [created]
|
||||
issues:
|
||||
types: [opened, labeled]
|
||||
pull_request:
|
||||
types: [opened]
|
||||
# Events for agent mode (only these work with agent mode)
|
||||
# Events for automation mode (runs with explicit prompt)
|
||||
workflow_dispatch:
|
||||
schedule:
|
||||
- cron: "0 0 * * 0" # Weekly on Sunday
|
||||
|
||||
jobs:
|
||||
# Tag Mode (Default) - Traditional implementation
|
||||
tag-mode-example:
|
||||
# Interactive Mode - Activated automatically when no prompt is provided
|
||||
interactive-mode-example:
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: write
|
||||
@@ -23,18 +23,17 @@ jobs:
|
||||
issues: write
|
||||
id-token: write
|
||||
steps:
|
||||
- uses: anthropics/claude-code-action@beta
|
||||
- uses: anthropics/claude-code-action@v1
|
||||
with:
|
||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||
# Tag mode (default) behavior:
|
||||
# Interactive mode (auto-detected when no prompt):
|
||||
# - Scans for @claude mentions in comments, issues, and PRs
|
||||
# - Only acts when trigger phrase is found
|
||||
# - Creates tracking comments with progress checkboxes
|
||||
# - Perfect for: Interactive Q&A, on-demand code changes
|
||||
|
||||
# Agent Mode - Automation for workflow_dispatch and schedule events
|
||||
agent-mode-scheduled-task:
|
||||
# Only works with workflow_dispatch or schedule events
|
||||
# Automation Mode - Activated automatically when prompt is provided
|
||||
automation-mode-scheduled-task:
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: write
|
||||
@@ -42,15 +41,14 @@ jobs:
|
||||
issues: write
|
||||
id-token: write
|
||||
steps:
|
||||
- uses: anthropics/claude-code-action@beta
|
||||
- uses: anthropics/claude-code-action@v1
|
||||
with:
|
||||
mode: agent
|
||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||
override_prompt: |
|
||||
prompt: |
|
||||
Check for outdated dependencies and security vulnerabilities.
|
||||
Create an issue if any critical problems are found.
|
||||
# Agent mode behavior:
|
||||
# - 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
|
||||
# Automation mode (auto-detected when prompt provided):
|
||||
# - Works with any GitHub event
|
||||
# - Executes immediately without waiting for @claude mentions
|
||||
# - No tracking comments created
|
||||
# - Perfect for: scheduled maintenance, automated reviews, CI/CD tasks
|
||||
|
||||
Reference in New Issue
Block a user