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
2026-01-22 22:44:13 +08:00 · 2025-08-21 13:34:38 -07:00
parent f7111a5d2b
commit b903a6e445
13 changed files with 580 additions and 195 deletions
--- a/docs/migration-guide.md
+++ b/docs/migration-guide.md
@@ -0,0 +1,219 @@
+# Migration Guide: v0.x to v1.0
+
+This guide helps you migrate from Claude Code Action v0.x to v1.0. The new version introduces intelligent mode detection and simplified configuration while maintaining backward compatibility for most use cases.
+
+## Overview of Changes
+
+### 🎯 Key Improvements in v1.0
+
+1. **Automatic Mode Detection** - No more manual `mode` configuration
+2. **Simplified Configuration** - Unified `prompt` and `claude_args` inputs
+3. **Better SDK Alignment** - Closer integration with Claude Code CLI
+
+### ⚠️ Breaking Changes
+
+The following inputs have been deprecated and replaced:
+
+| Deprecated Input      | Replacement                      | Notes                                         |
+| --------------------- | -------------------------------- | --------------------------------------------- |
+| `mode`                | Auto-detected                    | Action automatically chooses based on context |
+| `direct_prompt`       | `prompt`                         | Direct drop-in replacement                    |
+| `override_prompt`     | `prompt`                         | Use GitHub context variables instead          |
+| `custom_instructions` | `claude_args: --system-prompt`   | Move to CLI arguments                         |
+| `max_turns`           | `claude_args: --max-turns`       | Use CLI format                                |
+| `model`               | `claude_args: --model`           | Specify via CLI                               |
+| `allowed_tools`       | `claude_args: --allowedTools`    | Use CLI format                                |
+| `disallowed_tools`    | `claude_args: --disallowedTools` | Use CLI format                                |
+| `claude_env`          | `settings` with env object       | Use settings JSON                             |
+
+## Migration Examples
+
+### Basic Interactive Workflow (@claude mentions)
+
+**Before (v0.x):**
+
+```yaml
+- uses: anthropics/claude-code-action@beta
+  with:
+    mode: "tag"
+    anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
+    custom_instructions: "Follow our coding standards"
+    max_turns: "10"
+    allowed_tools: "Edit,Read,Write"
+```
+
+**After (v1.0):**
+
+```yaml
+- uses: anthropics/claude-code-action@v1
+  with:
+    anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
+    claude_args: |
+      --max-turns 10
+      --system-prompt "Follow our coding standards"
+      --allowedTools Edit,Read,Write
+```
+
+### Automation Workflow
+
+**Before (v0.x):**
+
+```yaml
+- uses: anthropics/claude-code-action@beta
+  with:
+    mode: "agent"
+    direct_prompt: "Review this PR for security issues"
+    anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
+    model: "claude-3-5-sonnet-20241022"
+    allowed_tools: "Edit,Read,Write"
+```
+
+**After (v1.0):**
+
+```yaml
+- uses: anthropics/claude-code-action@v1
+  with:
+    prompt: "Review this PR for security issues"
+    anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
+    claude_args: |
+      --model claude-4-0-sonnet-20250805
+      --allowedTools Edit,Read,Write
+```
+
+### Custom Template with Variables
+
+**Before (v0.x):**
+
+```yaml
+- uses: anthropics/claude-code-action@beta
+  with:
+    override_prompt: |
+      Analyze PR #$PR_NUMBER in $REPOSITORY
+      Changed files: $CHANGED_FILES
+      Focus on security vulnerabilities
+```
+
+**After (v1.0):**
+
+```yaml
+- uses: anthropics/claude-code-action@v1
+  with:
+    prompt: |
+      Analyze PR #${{ github.event.pull_request.number }} in ${{ github.repository }}
+      Focus on security vulnerabilities in the changed files
+```
+
+### Environment Variables
+
+**Before (v0.x):**
+
+```yaml
+- uses: anthropics/claude-code-action@beta
+  with:
+    claude_env: |
+      NODE_ENV: test
+      CI: true
+```
+
+**After (v1.0):**
+
+```yaml
+- uses: anthropics/claude-code-action@v1
+  with:
+    settings: |
+      {
+        "env": {
+          "NODE_ENV": "test",
+          "CI": "true"
+        }
+      }
+```
+
+## How Mode Detection Works
+
+The action now automatically detects the appropriate mode:
+
+1. **If `prompt` is provided** → Runs in **automation mode**
+
+   - Executes immediately without waiting for @claude mentions
+   - Perfect for scheduled tasks, PR automation, etc.
+
+2. **If no `prompt` but @claude is mentioned** → Runs in **interactive mode**
+
+   - Waits for and responds to @claude mentions
+   - Creates tracking comments with progress
+
+3. **If neither** → No action is taken
+
+## Advanced Configuration with claude_args
+
+The `claude_args` input provides direct access to Claude Code CLI arguments:
+
+```yaml
+claude_args: |
+  --max-turns 15
+  --model claude-4-0-sonnet-20250805
+  --allowedTools Edit,Read,Write,Bash
+  --disallowedTools WebSearch
+  --system-prompt "You are a senior engineer focused on code quality"
+```
+
+### Common claude_args Options
+
+| Option              | Description              | Example                               |
+| ------------------- | ------------------------ | ------------------------------------- |
+| `--max-turns`       | Limit conversation turns | `--max-turns 10`                      |
+| `--model`           | Specify Claude model     | `--model claude-4-0-sonnet-20250805`  |
+| `--allowedTools`    | Enable specific tools    | `--allowedTools Edit,Read,Write`      |
+| `--disallowedTools` | Disable specific tools   | `--disallowedTools WebSearch`         |
+| `--system-prompt`   | Add system instructions  | `--system-prompt "Focus on security"` |
+
+## Provider-Specific Updates
+
+### AWS Bedrock
+
+```yaml
+- uses: anthropics/claude-code-action@v1
+  with:
+    use_bedrock: "true"
+    claude_args: |
+      --model anthropic.claude-4-0-sonnet-20250805-v1:0
+```
+
+### Google Vertex AI
+
+```yaml
+- uses: anthropics/claude-code-action@v1
+  with:
+    use_vertex: "true"
+    claude_args: |
+      --model claude-4-0-sonnet@20250805
+```
+
+## Step-by-Step Migration Checklist
+
+- [ ] Update action version from `@beta` to `@v1`
+- [ ] Remove `mode` input (auto-detected now)
+- [ ] Replace `direct_prompt` with `prompt`
+- [ ] Replace `override_prompt` with `prompt` using GitHub context
+- [ ] Move `custom_instructions` to `claude_args` with `--system-prompt`
+- [ ] Convert `max_turns` to `claude_args` with `--max-turns`
+- [ ] Convert `model` to `claude_args` with `--model`
+- [ ] Convert `allowed_tools` to `claude_args` with `--allowedTools`
+- [ ] Convert `disallowed_tools` to `claude_args` with `--disallowedTools`
+- [ ] Move `claude_env` to `settings` JSON format
+- [ ] Test workflow in a non-production environment
+
+## Getting Help
+
+If you encounter issues during migration:
+
+1. Check the [FAQ](./faq.md) for common questions
+2. Review [example workflows](../examples/) for reference
+3. Open an [issue](https://github.com/anthropics/claude-code-action/issues) for support
+
+## Version Compatibility
+
+- **v0.x workflows** will continue to work but with deprecation warnings
+- **v1.0** is the recommended version for all new workflows
+- Future versions may remove deprecated inputs entirely