mirror of
https://github.com/anthropics/claude-code-action.git
synced 2026-01-27 01:52:24 +08:00
Compare commits
1 Commits
claude/upd
...
claude/upd
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
a6bed21f34 |
92
README.md
92
README.md
@@ -1,70 +1,70 @@
|
|||||||

|

|
||||||
|
|
||||||
# Claude Code Action
|
# Claude Code Action 🇦🇺
|
||||||
|
|
||||||
*Fáilte!* Welcome to the friendliest [Claude Code](https://claude.ai/code) action this side of the Atlantic! This grand little action for GitHub PRs and issues is as handy as a pocket on a shirt - answering your questions and implementing code changes like nobody's business. Sure, it's clever enough to know when to jump in based on your workflow context—whether you're giving it a shout with @claude mentions, assigning issues, or running automation tasks with explicit prompts. And wouldn't you know it, it works with multiple authentication methods including Anthropic direct API, Amazon Bedrock, and Google Vertex AI. *Go raibh maith agat* for choosing this action!
|
G'day mate! This is a fair dinkum [Claude Code](https://claude.ai/code) action for GitHub PRs and issues that'll help you out with questions and implement code changes like a proper legend. This ripper of an action is smart enough to know when to jump in based on your workflow context—whether you're giving it a bell with @claude mentions, chucking it an issue assignment, or running automation tasks with explicit prompts. She'll work with multiple authentication methods including Anthropic direct API, Amazon Bedrock, and Google Vertex AI. Beauty!
|
||||||
|
|
||||||
## What Makes This Action Pure Class
|
## What's the Go? (Features)
|
||||||
|
|
||||||
- 🎯 **Smart as a Whip**: Automatically picks the right execution mode based on your workflow context—no faffing about with configuration needed, *fair play*!
|
- 🎯 **Smart as a Whip Mode Detection**: Automatically picks the right execution mode based on your workflow context—no mucking about with config needed
|
||||||
- 🤖 **Your Grand Code Companion**: Claude's a dab hand at answering questions about code, architecture, and programming - like having a wise old uncle who knows his stuff
|
- 🤖 **Interactive Code Mate**: Claude's your coding buddy who can answer questions about code, architecture, and programming like nobody's business
|
||||||
- 🔍 **Eagle-Eyed Code Review**: Takes a gander at your PR changes and suggests improvements that'd make your mammy proud
|
- 🔍 **Code Review Champion**: Takes a squiz at your PR changes and suggests improvements that'll knock your socks off
|
||||||
- ✨ **Code Implementation Wizard**: Can implement simple fixes, refactoring, and even new features faster than you can say "sláinte"
|
- ✨ **Code Implementation Wizard**: Can bang out simple fixes, refactoring, and even new features faster than you can say "Bob's your uncle"
|
||||||
- 💬 **Smooth as Butter Integration**: Works like a dream with GitHub comments and PR reviews
|
- 💬 **PR/Issue Integration Bonza**: Works like a dream with GitHub comments and PR reviews
|
||||||
- 🛠️ **Handy Tool Access**: Gets at GitHub APIs and file operations (sure, you can enable more tools if you fancy)
|
- 🛠️ **Flexible Tool Access**: Gets stuck into GitHub APIs and file operations (additional tools can be cranked up via configuration)
|
||||||
- 📋 **Keeps You in the Loop**: Visual progress indicators with checkboxes that update as Claude gets the job done
|
- 📋 **Progress Tracking Beaut**: Visual progress indicators with checkboxes that update dynamically as Claude smashes through tasks
|
||||||
- 🏃 **Runs on Your Own Turf**: The action runs entirely on your own GitHub runner (Anthropic API calls go where you tell them to)
|
- 🏃 **Runs on Your Turf**: The action runs entirely on your own GitHub runner (Anthropic API calls go to your chosen provider)
|
||||||
- ⚙️ **Dead Simple Setup**: Unified `prompt` and `claude_args` inputs make configuration as easy as Sunday morning
|
- ⚙️ **No-Fuss Configuration**: Unified `prompt` and `claude_args` inputs provide clean, powerful configuration that's aligned with Claude Code SDK
|
||||||
|
|
||||||
## 📦 Moving Up from v0.x, Are Ya?
|
## 📦 Moving House from v0.x?
|
||||||
|
|
||||||
**Have a look at our [Migration Guide](./docs/migration-guide.md)** for step-by-step instructions on updating your workflows to v1.0. The new version makes configuration a doddle while keeping things working with most existing setups - *Bob's your uncle!*
|
**Chuck a look at our [Migration Guide](./docs/migration-guide.md)** for step-by-step instructions on updating your workflows to v1.0. The new version makes configuration a piece of piss while keeping things sweet with most existing setups.
|
||||||
|
|
||||||
## Getting Started (It's Grand, Really!)
|
## Getting Started (Quick Smart!)
|
||||||
|
|
||||||
The handiest way to set up this action is through [Claude Code](https://claude.ai/code) in the terminal. Just fire up `claude` and run `/install-github-app`.
|
The easiest way to get this action up and running is through [Claude Code](https://claude.ai/code) in the terminal. Just fire up `claude` and run `/install-github-app`.
|
||||||
|
|
||||||
This command will walk you through setting up the GitHub app and required secrets - sure it's as easy as boiling water!
|
This little beauty will walk you through setting up the GitHub app and all the secrets you need.
|
||||||
|
|
||||||
**Mind yourself now**:
|
**Fair Warning**:
|
||||||
|
|
||||||
- You'll need to be a repository admin to install the GitHub app and add secrets (*no getting around that one*)
|
- You'll need to be a repository admin to install the GitHub app and add secrets (no worries if you're the boss!)
|
||||||
- This quickstart method is only for direct Anthropic API users. If you're using AWS Bedrock or Google Vertex AI, pop over to [docs/cloud-providers.md](./docs/cloud-providers.md) - they'll sort you right out.
|
- This quickstart method is only for direct Anthropic API users. If you're using AWS Bedrock or Google Vertex AI, have a sticky beak at [docs/cloud-providers.md](./docs/cloud-providers.md).
|
||||||
|
|
||||||
## 📚 Brilliant Solutions & Ways to Use This Craic
|
## 📚 Solutions & Ripper Use Cases
|
||||||
|
|
||||||
Looking for specific automation patterns, are ya? Check our **[Solutions Guide](./docs/solutions.md)** - it's packed with complete working examples that'll have you sorted:
|
Looking for specific automation patterns? Have a captain cook at our **[Solutions Guide](./docs/solutions.md)** for complete working examples including:
|
||||||
|
|
||||||
- **🔍 Automatic PR Code Review** - Full review automation that's the bee's knees
|
- **🔍 Automatic PR Code Review** - Full review automation that's the cat's pyjamas
|
||||||
- **📂 Path-Specific Reviews** - Triggers when critical files change (sharp as a tack!)
|
- **📂 Path-Specific Reviews** - Triggers when critical files get a touch-up
|
||||||
- **👥 External Contributor Reviews** - Special handling for new contributors (*céad míle fáilte* to them!)
|
- **👥 External Contributor Reviews** - Special treatment for the new kids on the block
|
||||||
- **📝 Custom Review Checklists** - Keep your team standards tight as a drum
|
- **📝 Custom Review Checklists** - Keep your team standards tighter than a fish's backside
|
||||||
- **🔄 Scheduled Maintenance** - Automated repository health checks that never sleep
|
- **🔄 Scheduled Maintenance** - Automated repository health checks that run like clockwork
|
||||||
- **🏷️ Issue Triage & Labeling** - Automatic categorization faster than you can say "Tánaiste"
|
- **🏷️ Issue Triage & Labeling** - Automatic categorization that sorts things faster than a sheepdog
|
||||||
- **📖 Documentation Sync** - Keeps docs updated with code changes like clockwork
|
- **📖 Documentation Sync** - Keeps docs updated with code changes, no dramas
|
||||||
- **🔒 Security-Focused Reviews** - OWASP-aligned security analysis that's sound as a pound
|
- **🔒 Security-Focused Reviews** - OWASP-aligned security analysis that's tough as nails
|
||||||
- **📊 DIY Progress Tracking** - Create tracking comments in automation mode
|
- **📊 DIY Progress Tracking** - Create tracking comments in automation mode
|
||||||
|
|
||||||
Each solution comes with the full shebang - working examples, configuration details, and what you can expect. *Níl aon tinteán mar do thinteán féin* (there's no place like home), and these solutions will make your repository feel just like that!
|
Each solution comes with the full monty—working examples, configuration details, and what you can expect to see.
|
||||||
|
|
||||||
## The Full Library (Everything You Need to Know!)
|
## The Good Oil (Documentation)
|
||||||
|
|
||||||
- **[Solutions Guide](./docs/solutions.md)** - **🎯 Ready-to-use automation patterns that'll knock your socks off**
|
- **[Solutions Guide](./docs/solutions.md)** - **🎯 Ready-to-go automation patterns that'll make you smile**
|
||||||
- **[Migration Guide](./docs/migration-guide.md)** - **⭐ Moving from v0.x to v1.0 without breaking a sweat**
|
- **[Migration Guide](./docs/migration-guide.md)** - **⭐ Moving up from v0.x to v1.0**
|
||||||
- [Setup Guide](./docs/setup.md) - Manual setup, custom GitHub apps, and security best practices (*sure, we've got you covered*)
|
- [Setup Guide](./docs/setup.md) - Manual setup, custom GitHub apps, and security best practices (for the keen beans)
|
||||||
- [Usage Guide](./docs/usage.md) - Basic usage, workflow configuration, and input parameters - the bread and butter stuff
|
- [Usage Guide](./docs/usage.md) - Basic usage, workflow configuration, and input parameters (the bread and butter)
|
||||||
- [Custom Automations](./docs/custom-automations.md) - Examples of automated workflows and custom prompts that'll make your life easier
|
- [Custom Automations](./docs/custom-automations.md) - Examples of automated workflows and custom prompts that'll blow your mind
|
||||||
- [Configuration](./docs/configuration.md) - MCP servers, permissions, environment variables, and all the fancy advanced settings
|
- [Configuration](./docs/configuration.md) - MCP servers, permissions, environment variables, and advanced settings (for the tech heads)
|
||||||
- [Experimental Features](./docs/experimental.md) - Execution modes and network restrictions for the adventurous types
|
- [Experimental Features](./docs/experimental.md) - Execution modes and network restrictions (cutting edge stuff)
|
||||||
- [Cloud Providers](./docs/cloud-providers.md) - AWS Bedrock and Google Vertex AI setup (*for those who like their clouds with a bit of style*)
|
- [Cloud Providers](./docs/cloud-providers.md) - AWS Bedrock and Google Vertex AI setup (for the cloud cowboys)
|
||||||
- [Capabilities & Limitations](./docs/capabilities-and-limitations.md) - What Claude can and cannot do (we're keeping it real here)
|
- [Capabilities & Limitations](./docs/capabilities-and-limitations.md) - What Claude can and can't do (keeping it real)
|
||||||
- [Security](./docs/security.md) - Access control, permissions, and commit signing (*safe as houses*)
|
- [Security](./docs/security.md) - Access control, permissions, and commit signing (locked up tight)
|
||||||
- [FAQ](./docs/faq.md) - Common questions and troubleshooting for when things go a bit sideways
|
- [FAQ](./docs/faq.md) - Common questions and troubleshooting (when things go pear-shaped)
|
||||||
|
|
||||||
## 📚 Questions? We've Got Answers!
|
## 📚 Got Questions? She'll Be Right!
|
||||||
|
|
||||||
Having a bit of trouble or just curious about something? Take a gander at our [Frequently Asked Questions](./docs/faq.md) for solutions to common problems and detailed explanations of Claude's capabilities and limitations. Sure, we've probably answered it already - *great minds think alike!*
|
Having a bit of trouble or got some questions rattling around? Have a gander at our [Frequently Asked Questions](./docs/faq.md) for solutions to common problems and detailed explanations of what Claude can and can't do. No worries, mate!
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
This project is licensed under the MIT License—see the LICENSE file for all the legal bits and bobs. *Slán go fóill!* (goodbye for now!)
|
This project is licensed under the MIT License—have a squiz at the LICENSE file for all the nitty-gritty details.
|
||||||
|
|||||||
Reference in New Issue
Block a user