mirror of
https://github.com/anthropics/claude-code-action.git
synced 2026-01-22 22:44:13 +08:00
f2ceddc1a3
- Added new "Examples" section highlighting the examples/ folder - Included descriptions for all example workflow files - Provides clear guidance on how users can utilize the examples - Positioned strategically after Solutions & Use Cases section
86 lines
5.8 KiB
Markdown
86 lines
5.8 KiB
Markdown
|
|
|
|
# Claude Code Action
|
|
|
|
A general-purpose [Claude Code](https://claude.ai/code) action for GitHub PRs and issues that can answer questions and implement code changes. This action intelligently detects when to activate based on your workflow context—whether responding to @claude mentions, issue assignments, or executing automation tasks with explicit prompts. It supports multiple authentication methods including Anthropic direct API, Amazon Bedrock, and Google Vertex AI.
|
|
|
|
## Features
|
|
|
|
- 🎯 **Intelligent Mode Detection**: Automatically selects the appropriate execution mode based on your workflow context—no configuration needed
|
|
- 🤖 **Interactive Code Assistant**: Claude can answer questions about code, architecture, and programming
|
|
- 🔍 **Code Review**: Analyzes PR changes and suggests improvements
|
|
- ✨ **Code Implementation**: Can implement simple fixes, refactoring, and even new features
|
|
- 💬 **PR/Issue Integration**: Works seamlessly with GitHub comments and PR reviews
|
|
- 🛠️ **Flexible Tool Access**: Access to GitHub APIs and file operations (additional tools can be enabled via configuration)
|
|
- 📋 **Progress Tracking**: Visual progress indicators with checkboxes that dynamically update as Claude completes tasks
|
|
- 🏃 **Runs on Your Infrastructure**: The action executes entirely on your own GitHub runner (Anthropic API calls go to your chosen provider)
|
|
- ⚙️ **Simplified Configuration**: Unified `prompt` and `claude_args` inputs provide clean, powerful configuration aligned with Claude Code SDK
|
|
|
|
## 📦 Upgrading from v0.x?
|
|
|
|
**See our [Migration Guide](./docs/migration-guide.md)** for step-by-step instructions on updating your workflows to v1.0. The new version simplifies configuration while maintaining compatibility with most existing setups.
|
|
|
|
## Quickstart
|
|
|
|
The easiest way to set up this action is through [Claude Code](https://claude.ai/code) in the terminal. Just open `claude` and run `/install-github-app`.
|
|
|
|
This command will guide you through setting up the GitHub app and required secrets.
|
|
|
|
**Note**:
|
|
|
|
- You must be a repository admin to install the GitHub app and add secrets
|
|
- This quickstart method is only available for direct Anthropic API users. For AWS Bedrock or Google Vertex AI setup, see [docs/cloud-providers.md](./docs/cloud-providers.md).
|
|
|
|
## 📚 Solutions & Use Cases
|
|
|
|
Looking for specific automation patterns? Check our **[Solutions Guide](./docs/solutions.md)** for complete working examples including:
|
|
|
|
- **🔍 Automatic PR Code Review** - Full review automation
|
|
- **📂 Path-Specific Reviews** - Trigger on critical file changes
|
|
- **👥 External Contributor Reviews** - Special handling for new contributors
|
|
- **📝 Custom Review Checklists** - Enforce team standards
|
|
- **🔄 Scheduled Maintenance** - Automated repository health checks
|
|
- **🏷️ Issue Triage & Labeling** - Automatic categorization
|
|
- **📖 Documentation Sync** - Keep docs updated with code changes
|
|
- **🔒 Security-Focused Reviews** - OWASP-aligned security analysis
|
|
- **📊 DIY Progress Tracking** - Create tracking comments in automation mode
|
|
|
|
Each solution includes complete working examples, configuration details, and expected outcomes.
|
|
|
|
## 📁 Examples
|
|
|
|
The [`examples/`](./examples/) folder contains ready-to-use GitHub Actions workflow files that demonstrate various automation patterns:
|
|
|
|
- **[`pr-review-comprehensive.yml`](./examples/pr-review-comprehensive.yml)** - Complete PR review automation with progress tracking
|
|
- **[`pr-review-filtered-paths.yml`](./examples/pr-review-filtered-paths.yml)** - Trigger reviews only for specific file paths
|
|
- **[`pr-review-filtered-authors.yml`](./examples/pr-review-filtered-authors.yml)** - Special handling for external contributors
|
|
- **[`issue-triage.yml`](./examples/issue-triage.yml)** - Automatic issue categorization and labeling
|
|
- **[`issue-deduplication.yml`](./examples/issue-deduplication.yml)** - Detect and handle duplicate issues
|
|
- **[`ci-failure-auto-fix.yml`](./examples/ci-failure-auto-fix.yml)** - Automatic CI failure analysis and fixes
|
|
- **[`manual-code-analysis.yml`](./examples/manual-code-analysis.yml)** - On-demand code analysis workflows
|
|
- **[`claude.yml`](./examples/claude.yml)** - Basic setup for @claude mentions
|
|
|
|
Copy these examples directly into your `.github/workflows/` directory and customize them for your specific needs. Each example includes detailed comments explaining the configuration and expected behavior.
|
|
|
|
## Documentation
|
|
|
|
- **[Solutions Guide](./docs/solutions.md)** - **🎯 Ready-to-use automation patterns**
|
|
- **[Migration Guide](./docs/migration-guide.md)** - **⭐ Upgrading from v0.x to v1.0**
|
|
- [Setup Guide](./docs/setup.md) - Manual setup, custom GitHub apps, and security best practices
|
|
- [Usage Guide](./docs/usage.md) - Basic usage, workflow configuration, and input parameters
|
|
- [Custom Automations](./docs/custom-automations.md) - Examples of automated workflows and custom prompts
|
|
- [Configuration](./docs/configuration.md) - MCP servers, permissions, environment variables, and advanced settings
|
|
- [Experimental Features](./docs/experimental.md) - Execution modes and network restrictions
|
|
- [Cloud Providers](./docs/cloud-providers.md) - AWS Bedrock and Google Vertex AI setup
|
|
- [Capabilities & Limitations](./docs/capabilities-and-limitations.md) - What Claude can and cannot do
|
|
- [Security](./docs/security.md) - Access control, permissions, and commit signing
|
|
- [FAQ](./docs/faq.md) - Common questions and troubleshooting
|
|
|
|
## 📚 FAQ
|
|
|
|
Having issues or questions? Check out our [Frequently Asked Questions](./docs/faq.md) for solutions to common problems and detailed explanations of Claude's capabilities and limitations.
|
|
|
|
## License
|
|
|
|
This project is licensed under the MIT License—see the LICENSE file for details.
|