mirror of
https://github.com/anthropics/claude-code-action.git
synced 2026-01-22 22:44:13 +08:00
feat: make README more Australian
Updated the README with Australian slang and expressions while maintaining all technical information: - Added G'day greeting and fair dinkum language - Changed section headings to be more Aussie - Used expressions like "ripper", "bonzer", "she'll be right", "no worries mate" - Kept all documentation links and technical details intact 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
88
README.md
88
README.md
@@ -2,69 +2,69 @@
|
|||||||
|
|
||||||
# Claude Code Action
|
# 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.
|
G'day! This ripper of a [Claude Code](https://claude.ai/code) action for GitHub PRs and issues is fair dinkum brilliant at answering your questions and implementing code changes. This beauty intelligently sussess out when to kick into gear based on your workflow context—whether it's responding to @claude mentions, issue assignments, or executing automation tasks with explicit prompts. She'll work with multiple authentication methods including Anthropic direct API, Amazon Bedrock, and Google Vertex AI, no worries mate!
|
||||||
|
|
||||||
## Features
|
## What This Little Beauty Can Do
|
||||||
|
|
||||||
- 🎯 **Intelligent Mode Detection**: Automatically selects the appropriate execution mode based on your workflow context—no configuration needed
|
- 🎯 **Smart as a Whip Mode Detection**: Automatically picks the right execution mode based on your workflow context—she's got it sorted, no configuration needed mate
|
||||||
- 🤖 **Interactive Code Assistant**: Claude can answer questions about code, architecture, and programming
|
- 🤖 **Top-Notch Code Mate**: Claude can answer questions about code, architecture, and programming like a proper legend
|
||||||
- 🔍 **Code Review**: Analyzes PR changes and suggests improvements
|
- 🔍 **Code Review Champion**: Analyses PR changes and suggests improvements that'll knock your socks off
|
||||||
- ✨ **Code Implementation**: Can implement simple fixes, refactoring, and even new features
|
- ✨ **Code Implementation Wizard**: Can implement bonzer fixes, refactoring, and even new features
|
||||||
- 💬 **PR/Issue Integration**: Works seamlessly with GitHub comments and PR reviews
|
- 💬 **PR/Issue Integration That's Sweet as**: 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)
|
- 🛠️ **Flexible Tool Access**: Access to GitHub APIs and file operations (additional tools can be enabled via configuration—she's versatile!)
|
||||||
- 📋 **Progress Tracking**: Visual progress indicators with checkboxes that dynamically update as Claude completes tasks
|
- 📋 **Progress Tracking That's the Bee's Knees**: Visual progress indicators with checkboxes that dynamically update as Claude gets the job done
|
||||||
- 🏃 **Runs on Your Infrastructure**: The action executes entirely on your own GitHub runner (Anthropic API calls go to your chosen provider)
|
- 🏃 **Runs on Your Own Patch**: 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
|
- ⚙️ **Configuration So Simple It's Brilliant**: Unified `prompt` and `claude_args` inputs provide clean, powerful configuration aligned with Claude Code SDK
|
||||||
|
|
||||||
## 📦 Upgrading from v0.x?
|
## 📦 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.
|
**Check out our [Migration Guide](./docs/migration-guide.md)** for bonzer step-by-step instructions on updating your workflows to v1.0. The new version simplifies configuration while keeping things compatible with most existing setups—no dramas!
|
||||||
|
|
||||||
## Quickstart
|
## Getting Started (She'll Be Right!)
|
||||||
|
|
||||||
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`.
|
The easiest way to get this beauty 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 guide you through setting up the GitHub app and required secrets.
|
This ripper command will walk you through setting up the GitHub app and all the required secrets—easy as!
|
||||||
|
|
||||||
**Note**:
|
**Fair Warning**:
|
||||||
|
|
||||||
- You must be a repository admin to install the GitHub app and add secrets
|
- You'll need to be a repository admin to install the GitHub app and add secrets (no choice there, mate)
|
||||||
- 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).
|
- This quickstart method is only for direct Anthropic API users. For AWS Bedrock or Google Vertex AI setup, have a squiz at [docs/cloud-providers.md](./docs/cloud-providers.md).
|
||||||
|
|
||||||
## 📚 Solutions & Use Cases
|
## 📚 Solutions & Use Cases (The Good Stuff!)
|
||||||
|
|
||||||
Looking for specific automation patterns? Check our **[Solutions Guide](./docs/solutions.md)** for complete working examples including:
|
Looking for specific automation patterns? Chuck a look at our **[Solutions Guide](./docs/solutions.md)** for bonzer working examples including:
|
||||||
|
|
||||||
- **🔍 Automatic PR Code Review** - Full review automation
|
- **🔍 Automatic PR Code Review** - Full review automation that's ace
|
||||||
- **📂 Path-Specific Reviews** - Trigger on critical file changes
|
- **📂 Path-Specific Reviews** - Trigger on critical file changes (smart as!)
|
||||||
- **👥 External Contributor Reviews** - Special handling for new contributors
|
- **👥 External Contributor Reviews** - Special handling for new contributors (fair dinkum helpful)
|
||||||
- **📝 Custom Review Checklists** - Enforce team standards
|
- **📝 Custom Review Checklists** - Enforce team standards like a boss
|
||||||
- **🔄 Scheduled Maintenance** - Automated repository health checks
|
- **🔄 Scheduled Maintenance** - Automated repository health checks (keeping things shipshape)
|
||||||
- **🏷️ Issue Triage & Labeling** - Automatic categorization
|
- **🏷️ Issue Triage & Labeling** - Automatic categorization that's bloody brilliant
|
||||||
- **📖 Documentation Sync** - Keep docs updated with code changes
|
- **📖 Documentation Sync** - Keep docs updated with code changes (no more stale docs!)
|
||||||
- **🔒 Security-Focused Reviews** - OWASP-aligned security analysis
|
- **🔒 Security-Focused Reviews** - OWASP-aligned security analysis (safe as houses)
|
||||||
- **📊 DIY Progress Tracking** - Create tracking comments in automation mode
|
- **📊 DIY Progress Tracking** - Create tracking comments in automation mode
|
||||||
|
|
||||||
Each solution includes complete working examples, configuration details, and expected outcomes.
|
Each solution includes complete working examples, configuration details, and expected outcomes—everything you need to get cracking!
|
||||||
|
|
||||||
## Documentation
|
## Documentation (All The Good Oil)
|
||||||
|
|
||||||
- **[Solutions Guide](./docs/solutions.md)** - **🎯 Ready-to-use automation patterns**
|
- **[Solutions Guide](./docs/solutions.md)** - **🎯 Ready-to-use automation patterns (the real McCoy!)**
|
||||||
- **[Migration Guide](./docs/migration-guide.md)** - **⭐ Upgrading from v0.x to v1.0**
|
- **[Migration Guide](./docs/migration-guide.md)** - **⭐ Upgrading from v0.x to v1.0 (no worries!)**
|
||||||
- [Setup Guide](./docs/setup.md) - Manual setup, custom GitHub apps, and security best practices
|
- [Setup Guide](./docs/setup.md) - Manual setup, custom GitHub apps, and security best practices (sorted!)
|
||||||
- [Usage Guide](./docs/usage.md) - Basic usage, workflow configuration, and input parameters
|
- [Usage Guide](./docs/usage.md) - Basic usage, workflow configuration, and input parameters (easy as pie)
|
||||||
- [Custom Automations](./docs/custom-automations.md) - Examples of automated workflows and custom prompts
|
- [Custom Automations](./docs/custom-automations.md) - Examples of automated workflows and custom prompts (get creative!)
|
||||||
- [Configuration](./docs/configuration.md) - MCP servers, permissions, environment variables, and advanced settings
|
- [Configuration](./docs/configuration.md) - MCP servers, permissions, environment variables, and advanced settings (all the nuts and bolts)
|
||||||
- [Experimental Features](./docs/experimental.md) - Execution modes and network restrictions
|
- [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
|
- [Cloud Providers](./docs/cloud-providers.md) - AWS Bedrock and Google Vertex AI setup (cloud nine!)
|
||||||
- [Capabilities & Limitations](./docs/capabilities-and-limitations.md) - What Claude can and cannot do
|
- [Capabilities & Limitations](./docs/capabilities-and-limitations.md) - What Claude can and cannot do (the honest truth)
|
||||||
- [Security](./docs/security.md) - Access control, permissions, and commit signing
|
- [Security](./docs/security.md) - Access control, permissions, and commit signing (locked down tight)
|
||||||
- [FAQ](./docs/faq.md) - Common questions and troubleshooting
|
- [FAQ](./docs/faq.md) - Common questions and troubleshooting (when things go pear-shaped)
|
||||||
|
|
||||||
## 📚 FAQ
|
## 📚 FAQ (Got Questions?)
|
||||||
|
|
||||||
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.
|
Running into troubles or got questions? Have a geez at our [Frequently Asked Questions](./docs/faq.md) for solutions to common problems and detailed explanations of Claude's capabilities and limitations. She'll sort you right out!
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
This project is licensed under the MIT License—see the LICENSE file for details.
|
This project is licensed under the MIT License—check out the LICENSE file for all the legal bits and bobs.
|
||||||
|
|||||||
Reference in New Issue
Block a user