mirror of
https://github.com/anthropics/claude-code-action.git
synced 2026-01-24 07:24:12 +08:00
Compare commits
41 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
a1507aefdc | ||
|
|
ae66eb6a64 | ||
|
|
432c7cc889 | ||
|
|
0b138d9d49 | ||
|
|
c34e066a3b | ||
|
|
449c6791bd | ||
|
|
2b67ac084b | ||
|
|
76de8a48fc | ||
|
|
a80505bbfb | ||
|
|
af23644a50 | ||
|
|
98e6a902bf | ||
|
|
8b2bd6d04f | ||
|
|
4f4f43f044 | ||
|
|
8a5d751740 | ||
|
|
bc423b47f5 | ||
|
|
6d5c92076b | ||
|
|
fec554fc7c | ||
|
|
59ca6e42d9 | ||
|
|
7afc848186 | ||
|
|
6debac392b | ||
|
|
55fb6a96d0 | ||
|
|
15db2b3c79 | ||
|
|
188d526721 | ||
|
|
a519840051 | ||
|
|
85287e957d | ||
|
|
c6a07895d7 | ||
|
|
0c5d54472f | ||
|
|
2845685880 | ||
|
|
b39377f9bc | ||
|
|
618565bc0e | ||
|
|
0d9513b3b3 | ||
|
|
458e4b9e7f | ||
|
|
d66adfb7fa | ||
|
|
d829b4d14b | ||
|
|
0a78530f89 | ||
|
|
20e09ef881 | ||
|
|
56179f5fc9 | ||
|
|
0e5fbc0d44 | ||
|
|
b4cc5cd6c5 | ||
|
|
1b4ac7d7e0 | ||
|
|
1f6e3225b0 |
2
.github/workflows/claude.yml
vendored
2
.github/workflows/claude.yml
vendored
@@ -36,4 +36,4 @@ jobs:
|
|||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
allowed_tools: "Bash(bun install),Bash(bun test:*),Bash(bun run format),Bash(bun typecheck)"
|
allowed_tools: "Bash(bun install),Bash(bun test:*),Bash(bun run format),Bash(bun typecheck)"
|
||||||
custom_instructions: "You have also been granted tools for editing files and running bun commands (install, run, test, typecheck) for testing your changes: bun install, bun test, bun run format, bun typecheck."
|
custom_instructions: "You have also been granted tools for editing files and running bun commands (install, run, test, typecheck) for testing your changes: bun install, bun test, bun run format, bun typecheck."
|
||||||
model: "claude-opus-4-20250514"
|
model: "claude-opus-4-1-20250805"
|
||||||
|
|||||||
@@ -53,7 +53,7 @@ Execution steps:
|
|||||||
#### Mode System (`src/modes/`)
|
#### Mode System (`src/modes/`)
|
||||||
|
|
||||||
- **Tag Mode** (`tag/`): Responds to `@claude` mentions and issue assignments
|
- **Tag Mode** (`tag/`): Responds to `@claude` mentions and issue assignments
|
||||||
- **Agent Mode** (`agent/`): Automated execution without trigger checking
|
- **Agent Mode** (`agent/`): Automated execution for workflow_dispatch and schedule events only
|
||||||
- Extensible registry pattern in `modes/registry.ts`
|
- Extensible registry pattern in `modes/registry.ts`
|
||||||
|
|
||||||
#### GitHub Integration (`src/github/`)
|
#### GitHub Integration (`src/github/`)
|
||||||
@@ -118,7 +118,7 @@ src/
|
|||||||
|
|
||||||
- Modes implement `Mode` interface with `shouldTrigger()` and `prepare()` methods
|
- Modes implement `Mode` interface with `shouldTrigger()` and `prepare()` methods
|
||||||
- Registry validates mode compatibility with GitHub event types
|
- Registry validates mode compatibility with GitHub event types
|
||||||
- Agent mode bypasses all trigger checking for automation scenarios
|
- Agent mode only works with workflow_dispatch and schedule events
|
||||||
|
|
||||||
### Comment Threading
|
### Comment Threading
|
||||||
|
|
||||||
|
|||||||
956
README.md
956
README.md
@@ -14,6 +14,19 @@ A general-purpose [Claude Code](https://claude.ai/code) action for GitHub PRs an
|
|||||||
- 📋 **Progress Tracking**: Visual progress indicators with checkboxes that dynamically update as Claude completes tasks
|
- 📋 **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)
|
- 🏃 **Runs on Your Infrastructure**: The action executes entirely on your own GitHub runner (Anthropic API calls go to your chosen provider)
|
||||||
|
|
||||||
|
## ⚠️ **BREAKING CHANGES COMING IN v1.0** ⚠️
|
||||||
|
|
||||||
|
**We're planning a major update that will significantly change how this action works.** The new version will:
|
||||||
|
|
||||||
|
- ✨ Automatically select the appropriate mode (no more `mode` input)
|
||||||
|
- 🔧 Simplify configuration with unified `prompt` and `claude_args`
|
||||||
|
- 🚀 Align more closely with the Claude Code SDK capabilities
|
||||||
|
- 💥 Remove multiple inputs like `direct_prompt`, `custom_instructions`, and others
|
||||||
|
|
||||||
|
**[→ Read the full v1.0 roadmap and provide feedback](https://github.com/anthropics/claude-code-action/discussions/428)**
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Quickstart
|
## 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`.
|
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`.
|
||||||
@@ -23,942 +36,23 @@ This command will guide you through setting up the GitHub app and required secre
|
|||||||
**Note**:
|
**Note**:
|
||||||
|
|
||||||
- You must be a repository admin to install the GitHub app and add secrets
|
- 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. If you're using AWS Bedrock, please see the instructions below.
|
- 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).
|
||||||
|
|
||||||
### Manual Setup (Direct API)
|
## Documentation
|
||||||
|
|
||||||
**Requirements**: You must be a repository admin to complete these steps.
|
- [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
|
||||||
1. Install the Claude GitHub app to your repository: https://github.com/apps/claude
|
- [Custom Automations](./docs/custom-automations.md) - Examples of automated workflows and custom prompts
|
||||||
2. Add authentication to your repository secrets ([Learn how to use secrets in GitHub Actions](https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions)):
|
- [Configuration](./docs/configuration.md) - MCP servers, permissions, environment variables, and advanced settings
|
||||||
- Either `ANTHROPIC_API_KEY` for API key authentication
|
- [Experimental Features](./docs/experimental.md) - Execution modes and network restrictions
|
||||||
- Or `CLAUDE_CODE_OAUTH_TOKEN` for OAuth token authentication (Pro and Max users can generate this by running `claude setup-token` locally)
|
- [Cloud Providers](./docs/cloud-providers.md) - AWS Bedrock and Google Vertex AI setup
|
||||||
3. Copy the workflow file from [`examples/claude.yml`](./examples/claude.yml) into your repository's `.github/workflows/`
|
- [Capabilities & Limitations](./docs/capabilities-and-limitations.md) - What Claude can and cannot do
|
||||||
|
- [Security](./docs/security.md) - Access control, permissions, and commit signing
|
||||||
### Using a Custom GitHub App
|
- [FAQ](./docs/faq.md) - Common questions and troubleshooting
|
||||||
|
|
||||||
If you prefer not to install the official Claude app, you can create your own GitHub App to use with this action. This gives you complete control over permissions and access.
|
|
||||||
|
|
||||||
**When you may want to use a custom GitHub App:**
|
|
||||||
|
|
||||||
- You need more restrictive permissions than the official app
|
|
||||||
- Organization policies prevent installing third-party apps
|
|
||||||
- You're using AWS Bedrock or Google Vertex AI
|
|
||||||
|
|
||||||
**Steps to create and use a custom GitHub App:**
|
|
||||||
|
|
||||||
1. **Create a new GitHub App:**
|
|
||||||
|
|
||||||
- Go to https://github.com/settings/apps (for personal apps) or your organization's settings
|
|
||||||
- Click "New GitHub App"
|
|
||||||
- Configure the app with these minimum permissions:
|
|
||||||
- **Repository permissions:**
|
|
||||||
- Contents: Read & Write
|
|
||||||
- Issues: Read & Write
|
|
||||||
- Pull requests: Read & Write
|
|
||||||
- **Account permissions:** None required
|
|
||||||
- Set "Where can this GitHub App be installed?" to your preference
|
|
||||||
- Create the app
|
|
||||||
|
|
||||||
2. **Generate and download a private key:**
|
|
||||||
|
|
||||||
- After creating the app, scroll down to "Private keys"
|
|
||||||
- Click "Generate a private key"
|
|
||||||
- Download the `.pem` file (keep this secure!)
|
|
||||||
|
|
||||||
3. **Install the app on your repository:**
|
|
||||||
|
|
||||||
- Go to the app's settings page
|
|
||||||
- Click "Install App"
|
|
||||||
- Select the repositories where you want to use Claude
|
|
||||||
|
|
||||||
4. **Add the app credentials to your repository secrets:**
|
|
||||||
|
|
||||||
- Go to your repository's Settings → Secrets and variables → Actions
|
|
||||||
- Add these secrets:
|
|
||||||
- `APP_ID`: Your GitHub App's ID (found in the app settings)
|
|
||||||
- `APP_PRIVATE_KEY`: The contents of the downloaded `.pem` file
|
|
||||||
|
|
||||||
5. **Update your workflow to use the custom app:**
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
name: Claude with Custom App
|
|
||||||
on:
|
|
||||||
issue_comment:
|
|
||||||
types: [created]
|
|
||||||
# ... other triggers
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
claude-response:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
# Generate a token from your custom app
|
|
||||||
- name: Generate GitHub App token
|
|
||||||
id: app-token
|
|
||||||
uses: actions/create-github-app-token@v1
|
|
||||||
with:
|
|
||||||
app-id: ${{ secrets.APP_ID }}
|
|
||||||
private-key: ${{ secrets.APP_PRIVATE_KEY }}
|
|
||||||
|
|
||||||
# Use Claude with your custom app's token
|
|
||||||
- uses: anthropics/claude-code-action@beta
|
|
||||||
with:
|
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
|
||||||
github_token: ${{ steps.app-token.outputs.token }}
|
|
||||||
# ... other configuration
|
|
||||||
```
|
|
||||||
|
|
||||||
**Important notes:**
|
|
||||||
|
|
||||||
- The custom app must have read/write permissions for Issues, Pull Requests, and Contents
|
|
||||||
- Your app's token will have the exact permissions you configured, nothing more
|
|
||||||
|
|
||||||
For more information on creating GitHub Apps, see the [GitHub documentation](https://docs.github.com/en/apps/creating-github-apps).
|
|
||||||
|
|
||||||
## 📚 FAQ
|
## 📚 FAQ
|
||||||
|
|
||||||
Having issues or questions? Check out our [Frequently Asked Questions](./FAQ.md) for solutions to common problems and detailed explanations of Claude's capabilities and limitations.
|
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.
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
Add a workflow file to your repository (e.g., `.github/workflows/claude.yml`):
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
name: Claude Assistant
|
|
||||||
on:
|
|
||||||
issue_comment:
|
|
||||||
types: [created]
|
|
||||||
pull_request_review_comment:
|
|
||||||
types: [created]
|
|
||||||
issues:
|
|
||||||
types: [opened, assigned, labeled]
|
|
||||||
pull_request_review:
|
|
||||||
types: [submitted]
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
claude-response:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: anthropics/claude-code-action@beta
|
|
||||||
with:
|
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
|
||||||
# Or use OAuth token instead:
|
|
||||||
# claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
|
|
||||||
github_token: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
# Optional: set execution mode (default: tag)
|
|
||||||
# mode: "tag"
|
|
||||||
# Optional: add custom trigger phrase (default: @claude)
|
|
||||||
# trigger_phrase: "/claude"
|
|
||||||
# Optional: add assignee trigger for issues
|
|
||||||
# assignee_trigger: "claude"
|
|
||||||
# Optional: add label trigger for issues
|
|
||||||
# label_trigger: "claude"
|
|
||||||
# Optional: add custom environment variables (YAML format)
|
|
||||||
# claude_env: |
|
|
||||||
# NODE_ENV: test
|
|
||||||
# DEBUG: true
|
|
||||||
# API_URL: https://api.example.com
|
|
||||||
# Optional: limit the number of conversation turns
|
|
||||||
# max_turns: "5"
|
|
||||||
# Optional: grant additional permissions (requires corresponding GitHub token permissions)
|
|
||||||
# additional_permissions: |
|
|
||||||
# actions: read
|
|
||||||
```
|
|
||||||
|
|
||||||
## Inputs
|
|
||||||
|
|
||||||
| Input | Description | Required | Default |
|
|
||||||
| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------- | -------- | --------- |
|
|
||||||
| `mode` | Execution mode: 'tag' (default - triggered by mentions/assignments), 'agent' (for automation with no trigger checking) | No | `tag` |
|
|
||||||
| `anthropic_api_key` | Anthropic API key (required for direct API, not needed for Bedrock/Vertex) | No\* | - |
|
|
||||||
| `claude_code_oauth_token` | Claude Code OAuth token (alternative to anthropic_api_key) | No\* | - |
|
|
||||||
| `direct_prompt` | Direct prompt for Claude to execute automatically without needing a trigger (for automated workflows) | No | - |
|
|
||||||
| `override_prompt` | Complete replacement of Claude's prompt with custom template (supports variable substitution) | No | - |
|
|
||||||
| `base_branch` | The base branch to use for creating new branches (e.g., 'main', 'develop') | No | - |
|
|
||||||
| `max_turns` | Maximum number of conversation turns Claude can take (limits back-and-forth exchanges) | No | - |
|
|
||||||
| `timeout_minutes` | Timeout in minutes for execution | No | `30` |
|
|
||||||
| `use_sticky_comment` | Use just one comment to deliver PR comments (only applies for pull_request event workflows) | No | `false` |
|
|
||||||
| `github_token` | GitHub token for Claude to operate with. **Only include this if you're connecting a custom GitHub app of your own!** | No | - |
|
|
||||||
| `model` | Model to use (provider-specific format required for Bedrock/Vertex) | No | - |
|
|
||||||
| `fallback_model` | Enable automatic fallback to specified model when primary model is unavailable | No | - |
|
|
||||||
| `anthropic_model` | **DEPRECATED**: Use `model` instead. Kept for backward compatibility. | No | - |
|
|
||||||
| `use_bedrock` | Use Amazon Bedrock with OIDC authentication instead of direct Anthropic API | No | `false` |
|
|
||||||
| `use_vertex` | Use Google Vertex AI with OIDC authentication instead of direct Anthropic API | No | `false` |
|
|
||||||
| `allowed_tools` | Additional tools for Claude to use (the base GitHub tools will always be included) | No | "" |
|
|
||||||
| `disallowed_tools` | Tools that Claude should never use | No | "" |
|
|
||||||
| `custom_instructions` | Additional custom instructions to include in the prompt for Claude | No | "" |
|
|
||||||
| `mcp_config` | Additional MCP configuration (JSON string) that merges with the built-in GitHub MCP servers | No | "" |
|
|
||||||
| `assignee_trigger` | The assignee username that triggers the action (e.g. @claude). Only used for issue assignment | No | - |
|
|
||||||
| `label_trigger` | The label name that triggers the action when applied to an issue (e.g. "claude") | No | - |
|
|
||||||
| `trigger_phrase` | The trigger phrase to look for in comments, issue/PR bodies, and issue titles | No | `@claude` |
|
|
||||||
| `branch_prefix` | The prefix to use for Claude branches (defaults to 'claude/', use 'claude-' for dash format) | No | `claude/` |
|
|
||||||
| `claude_env` | Custom environment variables to pass to Claude Code execution (YAML format) | No | "" |
|
|
||||||
| `settings` | Claude Code settings as JSON string or path to settings JSON file | No | "" |
|
|
||||||
| `additional_permissions` | Additional permissions to enable. Currently supports 'actions: read' for viewing workflow results | No | "" |
|
|
||||||
| `experimental_allowed_domains` | Restrict network access to these domains only (newline-separated). | No | "" |
|
|
||||||
| `use_commit_signing` | Enable commit signing using GitHub's commit signature verification. When false, Claude uses standard git commands | No | `false` |
|
|
||||||
|
|
||||||
\*Required when using direct Anthropic API (default and when not using Bedrock or Vertex)
|
|
||||||
|
|
||||||
> **Note**: This action is currently in beta. Features and APIs may change as we continue to improve the integration.
|
|
||||||
|
|
||||||
## Execution Modes
|
|
||||||
|
|
||||||
The action supports two execution modes, each optimized for different use cases:
|
|
||||||
|
|
||||||
### Tag Mode (Default)
|
|
||||||
|
|
||||||
The traditional implementation mode that responds to @claude mentions, issue assignments, or labels.
|
|
||||||
|
|
||||||
- **Triggers**: `@claude` mentions, issue assignment, label application
|
|
||||||
- **Features**: Creates tracking comments with progress checkboxes, full implementation capabilities
|
|
||||||
- **Use case**: General-purpose code implementation and Q&A
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
- uses: anthropics/claude-code-action@beta
|
|
||||||
with:
|
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
|
||||||
# mode: tag is the default
|
|
||||||
```
|
|
||||||
|
|
||||||
### Agent Mode
|
|
||||||
|
|
||||||
For automation and scheduled tasks without trigger checking.
|
|
||||||
|
|
||||||
- **Triggers**: Always runs (no trigger checking)
|
|
||||||
- **Features**: Perfect for scheduled tasks, works with `override_prompt`
|
|
||||||
- **Use case**: Maintenance tasks, automated reporting, scheduled checks
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
- uses: anthropics/claude-code-action@beta
|
|
||||||
with:
|
|
||||||
mode: agent
|
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
|
||||||
override_prompt: |
|
|
||||||
Check for outdated dependencies and create an issue if any are found.
|
|
||||||
```
|
|
||||||
|
|
||||||
See [`examples/claude-modes.yml`](./examples/claude-modes.yml) for complete examples of each mode.
|
|
||||||
|
|
||||||
### Using Custom MCP Configuration
|
|
||||||
|
|
||||||
The `mcp_config` input allows you to add custom MCP (Model Context Protocol) servers to extend Claude's capabilities. These servers merge with the built-in GitHub MCP servers.
|
|
||||||
|
|
||||||
#### Basic Example: Adding a Sequential Thinking Server
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
- uses: anthropics/claude-code-action@beta
|
|
||||||
with:
|
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
|
||||||
mcp_config: |
|
|
||||||
{
|
|
||||||
"mcpServers": {
|
|
||||||
"sequential-thinking": {
|
|
||||||
"command": "npx",
|
|
||||||
"args": [
|
|
||||||
"-y",
|
|
||||||
"@modelcontextprotocol/server-sequential-thinking"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
allowed_tools: "mcp__sequential-thinking__sequentialthinking" # Important: Each MCP tool from your server must be listed here, comma-separated
|
|
||||||
# ... other inputs
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Passing Secrets to MCP Servers
|
|
||||||
|
|
||||||
For MCP servers that require sensitive information like API keys or tokens, use GitHub Secrets in the environment variables:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
- uses: anthropics/claude-code-action@beta
|
|
||||||
with:
|
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
|
||||||
mcp_config: |
|
|
||||||
{
|
|
||||||
"mcpServers": {
|
|
||||||
"custom-api-server": {
|
|
||||||
"command": "npx",
|
|
||||||
"args": ["-y", "@example/api-server"],
|
|
||||||
"env": {
|
|
||||||
"API_KEY": "${{ secrets.CUSTOM_API_KEY }}",
|
|
||||||
"BASE_URL": "https://api.example.com"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
# ... other inputs
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Using Python MCP Servers with uv
|
|
||||||
|
|
||||||
For Python-based MCP servers managed with `uv`, you need to specify the directory containing your server:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
- uses: anthropics/claude-code-action@beta
|
|
||||||
with:
|
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
|
||||||
mcp_config: |
|
|
||||||
{
|
|
||||||
"mcpServers": {
|
|
||||||
"my-python-server": {
|
|
||||||
"type": "stdio",
|
|
||||||
"command": "uv",
|
|
||||||
"args": [
|
|
||||||
"--directory",
|
|
||||||
"${{ github.workspace }}/path/to/server/",
|
|
||||||
"run",
|
|
||||||
"server_file.py"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
allowed_tools: "my-python-server__<tool_name>" # Replace <tool_name> with your server's tool names
|
|
||||||
# ... other inputs
|
|
||||||
```
|
|
||||||
|
|
||||||
For example, if your Python MCP server is at `mcp_servers/weather.py`, you would use:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
"args":
|
|
||||||
["--directory", "${{ github.workspace }}/mcp_servers/", "run", "weather.py"]
|
|
||||||
```
|
|
||||||
|
|
||||||
**Important**:
|
|
||||||
|
|
||||||
- Always use GitHub Secrets (`${{ secrets.SECRET_NAME }}`) for sensitive values like API keys, tokens, or passwords. Never hardcode secrets directly in the workflow file.
|
|
||||||
- Your custom servers will override any built-in servers with the same name.
|
|
||||||
|
|
||||||
## Examples
|
|
||||||
|
|
||||||
### Ways to Tag @claude
|
|
||||||
|
|
||||||
These examples show how to interact with Claude using comments in PRs and issues. By default, Claude will be triggered anytime you mention `@claude`, but you can customize the exact trigger phrase using the `trigger_phrase` input in the workflow.
|
|
||||||
|
|
||||||
Claude will see the full PR context, including any comments.
|
|
||||||
|
|
||||||
#### Ask Questions
|
|
||||||
|
|
||||||
Add a comment to a PR or issue:
|
|
||||||
|
|
||||||
```
|
|
||||||
@claude What does this function do and how could we improve it?
|
|
||||||
```
|
|
||||||
|
|
||||||
Claude will analyze the code and provide a detailed explanation with suggestions.
|
|
||||||
|
|
||||||
#### Request Fixes
|
|
||||||
|
|
||||||
Ask Claude to implement specific changes:
|
|
||||||
|
|
||||||
```
|
|
||||||
@claude Can you add error handling to this function?
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Code Review
|
|
||||||
|
|
||||||
Get a thorough review:
|
|
||||||
|
|
||||||
```
|
|
||||||
@claude Please review this PR and suggest improvements
|
|
||||||
```
|
|
||||||
|
|
||||||
Claude will analyze the changes and provide feedback.
|
|
||||||
|
|
||||||
#### Fix Bugs from Screenshots
|
|
||||||
|
|
||||||
Upload a screenshot of a bug and ask Claude to fix it:
|
|
||||||
|
|
||||||
```
|
|
||||||
@claude Here's a screenshot of a bug I'm seeing [upload screenshot]. Can you fix it?
|
|
||||||
```
|
|
||||||
|
|
||||||
Claude can see and analyze images, making it easy to fix visual bugs or UI issues.
|
|
||||||
|
|
||||||
### Custom Automations
|
|
||||||
|
|
||||||
These examples show how to configure Claude to act automatically based on GitHub events, without requiring manual @mentions.
|
|
||||||
|
|
||||||
#### Supported GitHub Events
|
|
||||||
|
|
||||||
This action supports the following GitHub events ([learn more GitHub event triggers](https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows)):
|
|
||||||
|
|
||||||
- `pull_request` - When PRs are opened or synchronized
|
|
||||||
- `issue_comment` - When comments are created on issues or PRs
|
|
||||||
- `pull_request_comment` - When comments are made on PR diffs
|
|
||||||
- `issues` - When issues are opened or assigned
|
|
||||||
- `pull_request_review` - When PR reviews are submitted
|
|
||||||
- `pull_request_review_comment` - When comments are made on PR reviews
|
|
||||||
- `repository_dispatch` - Custom events triggered via API (coming soon)
|
|
||||||
- `workflow_dispatch` - Manual workflow triggers (coming soon)
|
|
||||||
|
|
||||||
#### Automated Documentation Updates
|
|
||||||
|
|
||||||
Automatically update documentation when specific files change (see [`examples/claude-pr-path-specific.yml`](./examples/claude-pr-path-specific.yml)):
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
on:
|
|
||||||
pull_request:
|
|
||||||
paths:
|
|
||||||
- "src/api/**/*.ts"
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- uses: anthropics/claude-code-action@beta
|
|
||||||
with:
|
|
||||||
direct_prompt: |
|
|
||||||
Update the API documentation in README.md to reflect
|
|
||||||
the changes made to the API endpoints in this PR.
|
|
||||||
```
|
|
||||||
|
|
||||||
When API files are modified, Claude automatically updates your README with the latest endpoint documentation and pushes the changes back to the PR, keeping your docs in sync with your code.
|
|
||||||
|
|
||||||
#### Author-Specific Code Reviews
|
|
||||||
|
|
||||||
Automatically review PRs from specific authors or external contributors (see [`examples/claude-review-from-author.yml`](./examples/claude-review-from-author.yml)):
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
on:
|
|
||||||
pull_request:
|
|
||||||
types: [opened, synchronize]
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
review-by-author:
|
|
||||||
if: |
|
|
||||||
github.event.pull_request.user.login == 'developer1' ||
|
|
||||||
github.event.pull_request.user.login == 'external-contributor'
|
|
||||||
steps:
|
|
||||||
- uses: anthropics/claude-code-action@beta
|
|
||||||
with:
|
|
||||||
direct_prompt: |
|
|
||||||
Please provide a thorough review of this pull request.
|
|
||||||
Pay extra attention to coding standards, security practices,
|
|
||||||
and test coverage since this is from an external contributor.
|
|
||||||
```
|
|
||||||
|
|
||||||
Perfect for automatically reviewing PRs from new team members, external contributors, or specific developers who need extra guidance.
|
|
||||||
|
|
||||||
#### Custom Prompt Templates
|
|
||||||
|
|
||||||
Use `override_prompt` for complete control over Claude's behavior with variable substitution:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
- uses: anthropics/claude-code-action@beta
|
|
||||||
with:
|
|
||||||
override_prompt: |
|
|
||||||
Analyze PR #$PR_NUMBER in $REPOSITORY for security vulnerabilities.
|
|
||||||
|
|
||||||
Changed files:
|
|
||||||
$CHANGED_FILES
|
|
||||||
|
|
||||||
Focus on:
|
|
||||||
- SQL injection risks
|
|
||||||
- XSS vulnerabilities
|
|
||||||
- Authentication bypasses
|
|
||||||
- Exposed secrets or credentials
|
|
||||||
|
|
||||||
Provide severity ratings (Critical/High/Medium/Low) for any issues found.
|
|
||||||
```
|
|
||||||
|
|
||||||
The `override_prompt` feature supports these variables:
|
|
||||||
|
|
||||||
- `$REPOSITORY`, `$PR_NUMBER`, `$ISSUE_NUMBER`
|
|
||||||
- `$PR_TITLE`, `$ISSUE_TITLE`, `$PR_BODY`, `$ISSUE_BODY`
|
|
||||||
- `$PR_COMMENTS`, `$ISSUE_COMMENTS`, `$REVIEW_COMMENTS`
|
|
||||||
- `$CHANGED_FILES`, `$TRIGGER_COMMENT`, `$TRIGGER_USERNAME`
|
|
||||||
- `$BRANCH_NAME`, `$BASE_BRANCH`, `$EVENT_TYPE`, `$IS_PR`
|
|
||||||
|
|
||||||
## How It Works
|
|
||||||
|
|
||||||
1. **Trigger Detection**: Listens for comments containing the trigger phrase (default: `@claude`) or issue assignment to a specific user
|
|
||||||
2. **Context Gathering**: Analyzes the PR/issue, comments, code changes
|
|
||||||
3. **Smart Responses**: Either answers questions or implements changes
|
|
||||||
4. **Branch Management**: Creates new PRs for human authors, pushes directly for Claude's own PRs
|
|
||||||
5. **Communication**: Posts updates at every step to keep you informed
|
|
||||||
|
|
||||||
This action is built on top of [`anthropics/claude-code-base-action`](https://github.com/anthropics/claude-code-base-action).
|
|
||||||
|
|
||||||
## Capabilities and Limitations
|
|
||||||
|
|
||||||
### What Claude Can Do
|
|
||||||
|
|
||||||
- **Respond in a Single Comment**: Claude operates by updating a single initial comment with progress and results
|
|
||||||
- **Answer Questions**: Analyze code and provide explanations
|
|
||||||
- **Implement Code Changes**: Make simple to moderate code changes based on requests
|
|
||||||
- **Prepare Pull Requests**: Creates commits on a branch and links back to a prefilled PR creation page
|
|
||||||
- **Perform Code Reviews**: Analyze PR changes and provide detailed feedback
|
|
||||||
- **Smart Branch Handling**:
|
|
||||||
- When triggered on an **issue**: Always creates a new branch for the work
|
|
||||||
- When triggered on an **open PR**: Always pushes directly to the existing PR branch
|
|
||||||
- When triggered on a **closed PR**: Creates a new branch since the original is no longer active
|
|
||||||
- **View GitHub Actions Results**: Can access workflow runs, job logs, and test results on the PR where it's tagged when `actions: read` permission is configured (see [Additional Permissions for CI/CD Integration](#additional-permissions-for-cicd-integration))
|
|
||||||
|
|
||||||
### What Claude Cannot Do
|
|
||||||
|
|
||||||
- **Submit PR Reviews**: Claude cannot submit formal GitHub PR reviews
|
|
||||||
- **Approve PRs**: For security reasons, Claude cannot approve pull requests
|
|
||||||
- **Post Multiple Comments**: Claude only acts by updating its initial comment
|
|
||||||
- **Execute Commands Outside Its Context**: Claude only has access to the repository and PR/issue context it's triggered in
|
|
||||||
- **Run Arbitrary Bash Commands**: By default, Claude cannot execute Bash commands unless explicitly allowed using the `allowed_tools` configuration
|
|
||||||
- **Perform Branch Operations**: Cannot merge branches, rebase, or perform other git operations beyond pushing commits
|
|
||||||
|
|
||||||
## Advanced Configuration
|
|
||||||
|
|
||||||
### Additional Permissions for CI/CD Integration
|
|
||||||
|
|
||||||
The `additional_permissions` input allows Claude to access GitHub Actions workflow information when you grant the necessary permissions. This is particularly useful for analyzing CI/CD failures and debugging workflow issues.
|
|
||||||
|
|
||||||
#### Enabling GitHub Actions Access
|
|
||||||
|
|
||||||
To allow Claude to view workflow run results, job logs, and CI status:
|
|
||||||
|
|
||||||
1. **Grant the necessary permission to your GitHub token**:
|
|
||||||
|
|
||||||
- When using the default `GITHUB_TOKEN`, add the `actions: read` permission to your workflow:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
permissions:
|
|
||||||
contents: write
|
|
||||||
pull-requests: write
|
|
||||||
issues: write
|
|
||||||
actions: read # Add this line
|
|
||||||
```
|
|
||||||
|
|
||||||
2. **Configure the action with additional permissions**:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
- uses: anthropics/claude-code-action@beta
|
|
||||||
with:
|
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
|
||||||
additional_permissions: |
|
|
||||||
actions: read
|
|
||||||
# ... other inputs
|
|
||||||
```
|
|
||||||
|
|
||||||
3. **Claude will automatically get access to CI/CD tools**:
|
|
||||||
When you enable `actions: read`, Claude can use the following MCP tools:
|
|
||||||
- `mcp__github_ci__get_ci_status` - View workflow run statuses
|
|
||||||
- `mcp__github_ci__get_workflow_run_details` - Get detailed workflow information
|
|
||||||
- `mcp__github_ci__download_job_log` - Download and analyze job logs
|
|
||||||
|
|
||||||
#### Example: Debugging Failed CI Runs
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
name: Claude CI Helper
|
|
||||||
on:
|
|
||||||
issue_comment:
|
|
||||||
types: [created]
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: write
|
|
||||||
pull-requests: write
|
|
||||||
issues: write
|
|
||||||
actions: read # Required for CI access
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
claude-ci-helper:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: anthropics/claude-code-action@beta
|
|
||||||
with:
|
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
|
||||||
additional_permissions: |
|
|
||||||
actions: read
|
|
||||||
# Now Claude can respond to "@claude why did the CI fail?"
|
|
||||||
```
|
|
||||||
|
|
||||||
**Important Notes**:
|
|
||||||
|
|
||||||
- The GitHub token must have the `actions: read` permission in your workflow
|
|
||||||
- If the permission is missing, Claude will warn you and suggest adding it
|
|
||||||
- Currently, only `actions: read` is supported, but the format allows for future extensions
|
|
||||||
|
|
||||||
### Custom Environment Variables
|
|
||||||
|
|
||||||
You can pass custom environment variables to Claude Code execution using the `claude_env` input. This is useful for CI/test setups that require specific environment variables:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
- uses: anthropics/claude-code-action@beta
|
|
||||||
with:
|
|
||||||
claude_env: |
|
|
||||||
NODE_ENV: test
|
|
||||||
CI: true
|
|
||||||
DATABASE_URL: postgres://test:test@localhost:5432/test_db
|
|
||||||
# ... other inputs
|
|
||||||
```
|
|
||||||
|
|
||||||
The `claude_env` input accepts YAML format where each line defines a key-value pair. These environment variables will be available to Claude Code during execution, allowing it to run tests, build processes, or other commands that depend on specific environment configurations.
|
|
||||||
|
|
||||||
### Limiting Conversation Turns
|
|
||||||
|
|
||||||
You can use the `max_turns` parameter to limit the number of back-and-forth exchanges Claude can have during task execution. This is useful for:
|
|
||||||
|
|
||||||
- Controlling costs by preventing runaway conversations
|
|
||||||
- Setting time boundaries for automated workflows
|
|
||||||
- Ensuring predictable behavior in CI/CD pipelines
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
- uses: anthropics/claude-code-action@beta
|
|
||||||
with:
|
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
|
||||||
max_turns: "5" # Limit to 5 conversation turns
|
|
||||||
# ... other inputs
|
|
||||||
```
|
|
||||||
|
|
||||||
When the turn limit is reached, Claude will stop execution gracefully. Choose a value that gives Claude enough turns to complete typical tasks while preventing excessive usage.
|
|
||||||
|
|
||||||
### Custom Tools
|
|
||||||
|
|
||||||
By default, Claude only has access to:
|
|
||||||
|
|
||||||
- File operations (reading, committing, editing files, read-only git commands)
|
|
||||||
- Comment management (creating/updating comments)
|
|
||||||
- Basic GitHub operations
|
|
||||||
|
|
||||||
Claude does **not** have access to execute arbitrary Bash commands by default. If you want Claude to run specific commands (e.g., npm install, npm test), you must explicitly allow them using the `allowed_tools` configuration:
|
|
||||||
|
|
||||||
**Note**: If your repository has a `.mcp.json` file in the root directory, Claude will automatically detect and use the MCP server tools defined there. However, these tools still need to be explicitly allowed via the `allowed_tools` configuration.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
- uses: anthropics/claude-code-action@beta
|
|
||||||
with:
|
|
||||||
allowed_tools: |
|
|
||||||
Bash(npm install)
|
|
||||||
Bash(npm run test)
|
|
||||||
Edit
|
|
||||||
Replace
|
|
||||||
NotebookEditCell
|
|
||||||
disallowed_tools: |
|
|
||||||
TaskOutput
|
|
||||||
KillTask
|
|
||||||
# ... other inputs
|
|
||||||
```
|
|
||||||
|
|
||||||
**Note**: The base GitHub tools are always included. Use `allowed_tools` to add additional tools (including specific Bash commands), and `disallowed_tools` to prevent specific tools from being used.
|
|
||||||
|
|
||||||
### Custom Model
|
|
||||||
|
|
||||||
Use a specific Claude model:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
- uses: anthropics/claude-code-action@beta
|
|
||||||
with:
|
|
||||||
# model: "claude-3-5-sonnet-20241022" # Optional: specify a different model
|
|
||||||
# ... other inputs
|
|
||||||
```
|
|
||||||
|
|
||||||
### Network Restrictions
|
|
||||||
|
|
||||||
For enhanced security, you can restrict Claude's network access to specific domains only. This feature is particularly useful for:
|
|
||||||
|
|
||||||
- Enterprise environments with strict security policies
|
|
||||||
- Preventing access to external services
|
|
||||||
- Limiting Claude to only your internal APIs and services
|
|
||||||
|
|
||||||
When `experimental_allowed_domains` is set, Claude can only access the domains you explicitly list. You'll need to include the appropriate provider domains based on your authentication method.
|
|
||||||
|
|
||||||
#### Provider-Specific Examples
|
|
||||||
|
|
||||||
##### If using Anthropic API or subscription
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
- uses: anthropics/claude-code-action@beta
|
|
||||||
with:
|
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
|
||||||
# Or: claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
|
|
||||||
experimental_allowed_domains: |
|
|
||||||
.anthropic.com
|
|
||||||
```
|
|
||||||
|
|
||||||
##### If using AWS Bedrock
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
- uses: anthropics/claude-code-action@beta
|
|
||||||
with:
|
|
||||||
use_bedrock: "true"
|
|
||||||
experimental_allowed_domains: |
|
|
||||||
bedrock.*.amazonaws.com
|
|
||||||
bedrock-runtime.*.amazonaws.com
|
|
||||||
```
|
|
||||||
|
|
||||||
##### If using Google Vertex AI
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
- uses: anthropics/claude-code-action@beta
|
|
||||||
with:
|
|
||||||
use_vertex: "true"
|
|
||||||
experimental_allowed_domains: |
|
|
||||||
*.googleapis.com
|
|
||||||
vertexai.googleapis.com
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Common GitHub Domains
|
|
||||||
|
|
||||||
In addition to your provider domains, you may need to include GitHub-related domains. For GitHub.com users, common domains include:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
- uses: anthropics/claude-code-action@beta
|
|
||||||
with:
|
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
|
||||||
experimental_allowed_domains: |
|
|
||||||
.anthropic.com # For Anthropic API
|
|
||||||
.github.com
|
|
||||||
.githubusercontent.com
|
|
||||||
ghcr.io
|
|
||||||
.blob.core.windows.net
|
|
||||||
```
|
|
||||||
|
|
||||||
For GitHub Enterprise users, replace the GitHub.com domains above with your enterprise domains (e.g., `.github.company.com`, `packages.company.com`, etc.).
|
|
||||||
|
|
||||||
To determine which domains your workflow needs, you can temporarily run without restrictions and monitor the network requests, or check your GitHub Enterprise configuration for the specific services you use.
|
|
||||||
|
|
||||||
### Claude Code Settings
|
|
||||||
|
|
||||||
You can provide Claude Code settings to customize behavior such as model selection, environment variables, permissions, and hooks. Settings can be provided either as a JSON string or a path to a settings file.
|
|
||||||
|
|
||||||
#### Option 1: Settings File
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
- uses: anthropics/claude-code-action@beta
|
|
||||||
with:
|
|
||||||
settings: "path/to/settings.json"
|
|
||||||
# ... other inputs
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Option 2: Inline Settings
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
- uses: anthropics/claude-code-action@beta
|
|
||||||
with:
|
|
||||||
settings: |
|
|
||||||
{
|
|
||||||
"model": "claude-opus-4-20250514",
|
|
||||||
"env": {
|
|
||||||
"DEBUG": "true",
|
|
||||||
"API_URL": "https://api.example.com"
|
|
||||||
},
|
|
||||||
"permissions": {
|
|
||||||
"allow": ["Bash", "Read"],
|
|
||||||
"deny": ["WebFetch"]
|
|
||||||
},
|
|
||||||
"hooks": {
|
|
||||||
"PreToolUse": [{
|
|
||||||
"matcher": "Bash",
|
|
||||||
"hooks": [{
|
|
||||||
"type": "command",
|
|
||||||
"command": "echo Running bash command..."
|
|
||||||
}]
|
|
||||||
}]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
# ... other inputs
|
|
||||||
```
|
|
||||||
|
|
||||||
The settings support all Claude Code settings options including:
|
|
||||||
|
|
||||||
- `model`: Override the default model
|
|
||||||
- `env`: Environment variables for the session
|
|
||||||
- `permissions`: Tool usage permissions
|
|
||||||
- `hooks`: Pre/post tool execution hooks
|
|
||||||
- And more...
|
|
||||||
|
|
||||||
For a complete list of available settings and their descriptions, see the [Claude Code settings documentation](https://docs.anthropic.com/en/docs/claude-code/settings).
|
|
||||||
|
|
||||||
**Notes**:
|
|
||||||
|
|
||||||
- The `enableAllProjectMcpServers` setting is always set to `true` by this action to ensure MCP servers work correctly.
|
|
||||||
- If both the `model` input parameter and a `model` in settings are provided, the `model` input parameter takes precedence.
|
|
||||||
- The `allowed_tools` and `disallowed_tools` input parameters take precedence over `permissions` in settings.
|
|
||||||
- In a future version, we may deprecate individual input parameters in favor of using the settings file for all configuration.
|
|
||||||
|
|
||||||
## Cloud Providers
|
|
||||||
|
|
||||||
You can authenticate with Claude using any of these three methods:
|
|
||||||
|
|
||||||
1. Direct Anthropic API (default)
|
|
||||||
2. Amazon Bedrock with OIDC authentication
|
|
||||||
3. Google Vertex AI with OIDC authentication
|
|
||||||
|
|
||||||
For detailed setup instructions for AWS Bedrock and Google Vertex AI, see the [official documentation](https://docs.anthropic.com/en/docs/claude-code/github-actions#using-with-aws-bedrock-%26-google-vertex-ai).
|
|
||||||
|
|
||||||
**Note**:
|
|
||||||
|
|
||||||
- Bedrock and Vertex use OIDC authentication exclusively
|
|
||||||
- AWS Bedrock automatically uses cross-region inference profiles for certain models
|
|
||||||
- For cross-region inference profile models, you need to request and be granted access to the Claude models in all regions that the inference profile uses
|
|
||||||
|
|
||||||
### Model Configuration
|
|
||||||
|
|
||||||
Use provider-specific model names based on your chosen provider:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
# For direct Anthropic API (default)
|
|
||||||
- uses: anthropics/claude-code-action@beta
|
|
||||||
with:
|
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
|
||||||
# ... other inputs
|
|
||||||
|
|
||||||
# For Amazon Bedrock with OIDC
|
|
||||||
- uses: anthropics/claude-code-action@beta
|
|
||||||
with:
|
|
||||||
model: "anthropic.claude-3-7-sonnet-20250219-beta:0" # Cross-region inference
|
|
||||||
use_bedrock: "true"
|
|
||||||
# ... other inputs
|
|
||||||
|
|
||||||
# For Google Vertex AI with OIDC
|
|
||||||
- uses: anthropics/claude-code-action@beta
|
|
||||||
with:
|
|
||||||
model: "claude-3-7-sonnet@20250219"
|
|
||||||
use_vertex: "true"
|
|
||||||
# ... other inputs
|
|
||||||
```
|
|
||||||
|
|
||||||
### OIDC Authentication for Bedrock and Vertex
|
|
||||||
|
|
||||||
Both AWS Bedrock and GCP Vertex AI require OIDC authentication.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
# For AWS Bedrock with OIDC
|
|
||||||
- name: Configure AWS Credentials (OIDC)
|
|
||||||
uses: aws-actions/configure-aws-credentials@v4
|
|
||||||
with:
|
|
||||||
role-to-assume: ${{ secrets.AWS_ROLE_TO_ASSUME }}
|
|
||||||
aws-region: us-west-2
|
|
||||||
|
|
||||||
- name: Generate GitHub App token
|
|
||||||
id: app-token
|
|
||||||
uses: actions/create-github-app-token@v2
|
|
||||||
with:
|
|
||||||
app-id: ${{ secrets.APP_ID }}
|
|
||||||
private-key: ${{ secrets.APP_PRIVATE_KEY }}
|
|
||||||
|
|
||||||
- uses: anthropics/claude-code-action@beta
|
|
||||||
with:
|
|
||||||
model: "anthropic.claude-3-7-sonnet-20250219-beta:0"
|
|
||||||
use_bedrock: "true"
|
|
||||||
# ... other inputs
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
id-token: write # Required for OIDC
|
|
||||||
```
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
# For GCP Vertex AI with OIDC
|
|
||||||
- name: Authenticate to Google Cloud
|
|
||||||
uses: google-github-actions/auth@v2
|
|
||||||
with:
|
|
||||||
workload_identity_provider: ${{ secrets.GCP_WORKLOAD_IDENTITY_PROVIDER }}
|
|
||||||
service_account: ${{ secrets.GCP_SERVICE_ACCOUNT }}
|
|
||||||
|
|
||||||
- name: Generate GitHub App token
|
|
||||||
id: app-token
|
|
||||||
uses: actions/create-github-app-token@v2
|
|
||||||
with:
|
|
||||||
app-id: ${{ secrets.APP_ID }}
|
|
||||||
private-key: ${{ secrets.APP_PRIVATE_KEY }}
|
|
||||||
|
|
||||||
- uses: anthropics/claude-code-action@beta
|
|
||||||
with:
|
|
||||||
model: "claude-3-7-sonnet@20250219"
|
|
||||||
use_vertex: "true"
|
|
||||||
# ... other inputs
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
id-token: write # Required for OIDC
|
|
||||||
```
|
|
||||||
|
|
||||||
## Security
|
|
||||||
|
|
||||||
### Access Control
|
|
||||||
|
|
||||||
- **Repository Access**: The action can only be triggered by users with write access to the repository
|
|
||||||
- **No Bot Triggers**: GitHub Apps and bots cannot trigger this action
|
|
||||||
- **Token Permissions**: The GitHub app receives only a short-lived token scoped specifically to the repository it's operating in
|
|
||||||
- **No Cross-Repository Access**: Each action invocation is limited to the repository where it was triggered
|
|
||||||
- **Limited Scope**: The token cannot access other repositories or perform actions beyond the configured permissions
|
|
||||||
|
|
||||||
### GitHub App Permissions
|
|
||||||
|
|
||||||
The [Claude Code GitHub app](https://github.com/apps/claude) requires these permissions:
|
|
||||||
|
|
||||||
- **Pull Requests**: Read and write to create PRs and push changes
|
|
||||||
- **Issues**: Read and write to respond to issues
|
|
||||||
- **Contents**: Read and write to modify repository files
|
|
||||||
|
|
||||||
### Commit Signing
|
|
||||||
|
|
||||||
All commits made by Claude through this action are automatically signed with commit signatures. This ensures the authenticity and integrity of commits, providing a verifiable trail of changes made by the action.
|
|
||||||
|
|
||||||
### ⚠️ Authentication Protection
|
|
||||||
|
|
||||||
**CRITICAL: Never hardcode your Anthropic API key or OAuth token in workflow files!**
|
|
||||||
|
|
||||||
Your authentication credentials must always be stored in GitHub secrets to prevent unauthorized access:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
# CORRECT ✅
|
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
|
||||||
# OR
|
|
||||||
claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
|
|
||||||
|
|
||||||
# NEVER DO THIS ❌
|
|
||||||
anthropic_api_key: "sk-ant-api03-..." # Exposed and vulnerable!
|
|
||||||
claude_code_oauth_token: "oauth_token_..." # Exposed and vulnerable!
|
|
||||||
```
|
|
||||||
|
|
||||||
### Setting Up GitHub Secrets
|
|
||||||
|
|
||||||
1. Go to your repository's Settings
|
|
||||||
2. Click on "Secrets and variables" → "Actions"
|
|
||||||
3. Click "New repository secret"
|
|
||||||
4. For authentication, choose one:
|
|
||||||
- API Key: Name: `ANTHROPIC_API_KEY`, Value: Your Anthropic API key (starting with `sk-ant-`)
|
|
||||||
- OAuth Token: Name: `CLAUDE_CODE_OAUTH_TOKEN`, Value: Your Claude Code OAuth token (Pro and Max users can generate this by running `claude setup-token` locally)
|
|
||||||
5. Click "Add secret"
|
|
||||||
|
|
||||||
### Best Practices for Authentication
|
|
||||||
|
|
||||||
1. ✅ Always use `${{ secrets.ANTHROPIC_API_KEY }}` or `${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}` in workflows
|
|
||||||
2. ✅ Never commit API keys or tokens to version control
|
|
||||||
3. ✅ Regularly rotate your API keys and tokens
|
|
||||||
4. ✅ Use environment secrets for organization-wide access
|
|
||||||
5. ❌ Never share API keys or tokens in pull requests or issues
|
|
||||||
6. ❌ Avoid logging workflow variables that might contain keys
|
|
||||||
|
|
||||||
## Security Best Practices
|
|
||||||
|
|
||||||
**⚠️ IMPORTANT: Never commit API keys directly to your repository! Always use GitHub Actions secrets.**
|
|
||||||
|
|
||||||
To securely use your Anthropic API key:
|
|
||||||
|
|
||||||
1. Add your API key as a repository secret:
|
|
||||||
|
|
||||||
- Go to your repository's Settings
|
|
||||||
- Navigate to "Secrets and variables" → "Actions"
|
|
||||||
- Click "New repository secret"
|
|
||||||
- Name it `ANTHROPIC_API_KEY`
|
|
||||||
- Paste your API key as the value
|
|
||||||
|
|
||||||
2. Reference the secret in your workflow:
|
|
||||||
```yaml
|
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
|
||||||
```
|
|
||||||
|
|
||||||
**Never do this:**
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
# ❌ WRONG - Exposes your API key
|
|
||||||
anthropic_api_key: "sk-ant-..."
|
|
||||||
```
|
|
||||||
|
|
||||||
**Always do this:**
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
# ✅ CORRECT - Uses GitHub secrets
|
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
|
||||||
```
|
|
||||||
|
|
||||||
This applies to all sensitive values including API keys, access tokens, and credentials.
|
|
||||||
We also recommend that you always use short-lived tokens when possible
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ Thank you for trying out the beta of our GitHub Action! This document outlines o
|
|||||||
- **Support for workflow_dispatch and repository_dispatch events** - Dispatch Claude on events triggered via API from other workflows or from other services
|
- **Support for workflow_dispatch and repository_dispatch events** - Dispatch Claude on events triggered via API from other workflows or from other services
|
||||||
- **Ability to disable commit signing** - Option to turn off GPG signing for environments where it's not required. This will enable Claude to use normal `git` bash commands for committing. This will likely become the default behavior once added.
|
- **Ability to disable commit signing** - Option to turn off GPG signing for environments where it's not required. This will enable Claude to use normal `git` bash commands for committing. This will likely become the default behavior once added.
|
||||||
- **Better code review behavior** - Support inline comments on specific lines, provide higher quality reviews with more actionable feedback
|
- **Better code review behavior** - Support inline comments on specific lines, provide higher quality reviews with more actionable feedback
|
||||||
- **Support triggering @claude from bot users** - Allow automation and bot accounts to invoke Claude
|
- ~**Support triggering @claude from bot users** - Allow automation and bot accounts to invoke Claude~
|
||||||
- **Customizable base prompts** - Full control over Claude's initial context with template variables like `$PR_COMMENTS`, `$PR_FILES`, etc. Users can replace our default prompt entirely while still accessing key contextual data
|
- **Customizable base prompts** - Full control over Claude's initial context with template variables like `$PR_COMMENTS`, `$PR_FILES`, etc. Users can replace our default prompt entirely while still accessing key contextual data
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|||||||
14
action.yml
14
action.yml
@@ -23,10 +23,14 @@ inputs:
|
|||||||
description: "The prefix to use for Claude branches (defaults to 'claude/', use 'claude-' for dash format)"
|
description: "The prefix to use for Claude branches (defaults to 'claude/', use 'claude-' for dash format)"
|
||||||
required: false
|
required: false
|
||||||
default: "claude/"
|
default: "claude/"
|
||||||
|
allowed_bots:
|
||||||
|
description: "Comma-separated list of allowed bot usernames, or '*' to allow all bots. Empty string (default) allows no bots."
|
||||||
|
required: false
|
||||||
|
default: ""
|
||||||
|
|
||||||
# Mode configuration
|
# Mode configuration
|
||||||
mode:
|
mode:
|
||||||
description: "Execution mode for the action. Valid modes: 'tag' (default - triggered by mentions/assignments), 'agent' (for automation with no trigger checking)"
|
description: "Execution mode for the action. Valid modes: 'tag' (default - triggered by mentions/assignments), 'agent' (for automation with no trigger checking), 'experimental-review' (experimental mode for code reviews with inline comments and suggestions)"
|
||||||
required: false
|
required: false
|
||||||
default: "tag"
|
default: "tag"
|
||||||
|
|
||||||
@@ -156,9 +160,10 @@ runs:
|
|||||||
OVERRIDE_PROMPT: ${{ inputs.override_prompt }}
|
OVERRIDE_PROMPT: ${{ inputs.override_prompt }}
|
||||||
MCP_CONFIG: ${{ inputs.mcp_config }}
|
MCP_CONFIG: ${{ inputs.mcp_config }}
|
||||||
OVERRIDE_GITHUB_TOKEN: ${{ inputs.github_token }}
|
OVERRIDE_GITHUB_TOKEN: ${{ inputs.github_token }}
|
||||||
|
ALLOWED_BOTS: ${{ inputs.allowed_bots }}
|
||||||
GITHUB_RUN_ID: ${{ github.run_id }}
|
GITHUB_RUN_ID: ${{ github.run_id }}
|
||||||
USE_STICKY_COMMENT: ${{ inputs.use_sticky_comment }}
|
USE_STICKY_COMMENT: ${{ inputs.use_sticky_comment }}
|
||||||
ACTIONS_TOKEN: ${{ github.token }}
|
DEFAULT_WORKFLOW_TOKEN: ${{ github.token }}
|
||||||
ADDITIONAL_PERMISSIONS: ${{ inputs.additional_permissions }}
|
ADDITIONAL_PERMISSIONS: ${{ inputs.additional_permissions }}
|
||||||
USE_COMMIT_SIGNING: ${{ inputs.use_commit_signing }}
|
USE_COMMIT_SIGNING: ${{ inputs.use_commit_signing }}
|
||||||
|
|
||||||
@@ -172,7 +177,7 @@ runs:
|
|||||||
echo "Base-action dependencies installed"
|
echo "Base-action dependencies installed"
|
||||||
cd -
|
cd -
|
||||||
# Install Claude Code globally
|
# Install Claude Code globally
|
||||||
bun install -g @anthropic-ai/claude-code@1.0.63
|
curl -fsSL https://claude.ai/install.sh | bash -s 1.0.81
|
||||||
|
|
||||||
- name: Setup Network Restrictions
|
- name: Setup Network Restrictions
|
||||||
if: steps.prepare.outputs.contains_trigger == 'true' && inputs.experimental_allowed_domains != ''
|
if: steps.prepare.outputs.contains_trigger == 'true' && inputs.experimental_allowed_domains != ''
|
||||||
@@ -201,10 +206,11 @@ runs:
|
|||||||
INPUT_MCP_CONFIG: ${{ steps.prepare.outputs.mcp_config }}
|
INPUT_MCP_CONFIG: ${{ steps.prepare.outputs.mcp_config }}
|
||||||
INPUT_SETTINGS: ${{ inputs.settings }}
|
INPUT_SETTINGS: ${{ inputs.settings }}
|
||||||
INPUT_SYSTEM_PROMPT: ""
|
INPUT_SYSTEM_PROMPT: ""
|
||||||
INPUT_APPEND_SYSTEM_PROMPT: ""
|
INPUT_APPEND_SYSTEM_PROMPT: ${{ env.APPEND_SYSTEM_PROMPT }}
|
||||||
INPUT_TIMEOUT_MINUTES: ${{ inputs.timeout_minutes }}
|
INPUT_TIMEOUT_MINUTES: ${{ inputs.timeout_minutes }}
|
||||||
INPUT_CLAUDE_ENV: ${{ inputs.claude_env }}
|
INPUT_CLAUDE_ENV: ${{ inputs.claude_env }}
|
||||||
INPUT_FALLBACK_MODEL: ${{ inputs.fallback_model }}
|
INPUT_FALLBACK_MODEL: ${{ inputs.fallback_model }}
|
||||||
|
INPUT_EXPERIMENTAL_SLASH_COMMANDS_DIR: ${{ github.action_path }}/slash-commands
|
||||||
|
|
||||||
# Model configuration
|
# Model configuration
|
||||||
ANTHROPIC_MODEL: ${{ inputs.model || inputs.anthropic_model }}
|
ANTHROPIC_MODEL: ${{ inputs.model || inputs.anthropic_model }}
|
||||||
|
|||||||
@@ -69,7 +69,7 @@ Add the following to your workflow file:
|
|||||||
uses: anthropics/claude-code-base-action@beta
|
uses: anthropics/claude-code-base-action@beta
|
||||||
with:
|
with:
|
||||||
prompt: "Review and fix TypeScript errors"
|
prompt: "Review and fix TypeScript errors"
|
||||||
model: "claude-opus-4-20250514"
|
model: "claude-opus-4-1-20250805"
|
||||||
fallback_model: "claude-sonnet-4-20250514"
|
fallback_model: "claude-sonnet-4-20250514"
|
||||||
allowed_tools: "Bash(git:*),View,GlobTool,GrepTool,BatchTool"
|
allowed_tools: "Bash(git:*),View,GlobTool,GrepTool,BatchTool"
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
@@ -217,7 +217,7 @@ Provide the settings configuration directly as a JSON string:
|
|||||||
prompt: "Your prompt here"
|
prompt: "Your prompt here"
|
||||||
settings: |
|
settings: |
|
||||||
{
|
{
|
||||||
"model": "claude-opus-4-20250514",
|
"model": "claude-opus-4-1-20250805",
|
||||||
"env": {
|
"env": {
|
||||||
"DEBUG": "true",
|
"DEBUG": "true",
|
||||||
"API_URL": "https://api.example.com"
|
"API_URL": "https://api.example.com"
|
||||||
|
|||||||
@@ -61,6 +61,9 @@ inputs:
|
|||||||
description: "Timeout in minutes for Claude Code execution"
|
description: "Timeout in minutes for Claude Code execution"
|
||||||
required: false
|
required: false
|
||||||
default: "10"
|
default: "10"
|
||||||
|
experimental_slash_commands_dir:
|
||||||
|
description: "Experimental: Directory containing slash command files to install"
|
||||||
|
required: false
|
||||||
|
|
||||||
# Authentication settings
|
# Authentication settings
|
||||||
anthropic_api_key:
|
anthropic_api_key:
|
||||||
@@ -115,7 +118,7 @@ runs:
|
|||||||
|
|
||||||
- name: Install Claude Code
|
- name: Install Claude Code
|
||||||
shell: bash
|
shell: bash
|
||||||
run: bun install -g @anthropic-ai/claude-code@1.0.63
|
run: curl -fsSL https://claude.ai/install.sh | bash -s 1.0.81
|
||||||
|
|
||||||
- name: Run Claude Code Action
|
- name: Run Claude Code Action
|
||||||
shell: bash
|
shell: bash
|
||||||
@@ -143,6 +146,7 @@ runs:
|
|||||||
INPUT_TIMEOUT_MINUTES: ${{ inputs.timeout_minutes }}
|
INPUT_TIMEOUT_MINUTES: ${{ inputs.timeout_minutes }}
|
||||||
INPUT_CLAUDE_ENV: ${{ inputs.claude_env }}
|
INPUT_CLAUDE_ENV: ${{ inputs.claude_env }}
|
||||||
INPUT_FALLBACK_MODEL: ${{ inputs.fallback_model }}
|
INPUT_FALLBACK_MODEL: ${{ inputs.fallback_model }}
|
||||||
|
INPUT_EXPERIMENTAL_SLASH_COMMANDS_DIR: ${{ inputs.experimental_slash_commands_dir }}
|
||||||
|
|
||||||
# Provider configuration
|
# Provider configuration
|
||||||
ANTHROPIC_API_KEY: ${{ inputs.anthropic_api_key }}
|
ANTHROPIC_API_KEY: ${{ inputs.anthropic_api_key }}
|
||||||
|
|||||||
@@ -10,7 +10,11 @@ async function run() {
|
|||||||
try {
|
try {
|
||||||
validateEnvironmentVariables();
|
validateEnvironmentVariables();
|
||||||
|
|
||||||
await setupClaudeCodeSettings(process.env.INPUT_SETTINGS);
|
await setupClaudeCodeSettings(
|
||||||
|
process.env.INPUT_SETTINGS,
|
||||||
|
undefined, // homeDir
|
||||||
|
process.env.INPUT_EXPERIMENTAL_SLASH_COMMANDS_DIR,
|
||||||
|
);
|
||||||
|
|
||||||
const promptConfig = await preparePrompt({
|
const promptConfig = await preparePrompt({
|
||||||
prompt: process.env.INPUT_PROMPT || "",
|
prompt: process.env.INPUT_PROMPT || "",
|
||||||
|
|||||||
@@ -5,6 +5,7 @@ import { readFile } from "fs/promises";
|
|||||||
export async function setupClaudeCodeSettings(
|
export async function setupClaudeCodeSettings(
|
||||||
settingsInput?: string,
|
settingsInput?: string,
|
||||||
homeDir?: string,
|
homeDir?: string,
|
||||||
|
slashCommandsDir?: string,
|
||||||
) {
|
) {
|
||||||
const home = homeDir ?? homedir();
|
const home = homeDir ?? homedir();
|
||||||
const settingsPath = `${home}/.claude/settings.json`;
|
const settingsPath = `${home}/.claude/settings.json`;
|
||||||
@@ -65,4 +66,17 @@ export async function setupClaudeCodeSettings(
|
|||||||
|
|
||||||
await $`echo ${JSON.stringify(settings, null, 2)} > ${settingsPath}`.quiet();
|
await $`echo ${JSON.stringify(settings, null, 2)} > ${settingsPath}`.quiet();
|
||||||
console.log(`Settings saved successfully`);
|
console.log(`Settings saved successfully`);
|
||||||
|
|
||||||
|
if (slashCommandsDir) {
|
||||||
|
console.log(
|
||||||
|
`Copying slash commands from ${slashCommandsDir} to ${home}/.claude/`,
|
||||||
|
);
|
||||||
|
try {
|
||||||
|
await $`test -d ${slashCommandsDir}`.quiet();
|
||||||
|
await $`cp ${slashCommandsDir}/*.md ${home}/.claude/ 2>/dev/null || true`.quiet();
|
||||||
|
console.log(`Slash commands copied successfully`);
|
||||||
|
} catch (e) {
|
||||||
|
console.log(`Slash commands directory not found or error copying: ${e}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
import { describe, test, expect, beforeEach, afterEach } from "bun:test";
|
import { describe, test, expect, beforeEach, afterEach } from "bun:test";
|
||||||
import { setupClaudeCodeSettings } from "../src/setup-claude-code-settings";
|
import { setupClaudeCodeSettings } from "../src/setup-claude-code-settings";
|
||||||
import { tmpdir } from "os";
|
import { tmpdir } from "os";
|
||||||
import { mkdir, writeFile, readFile, rm } from "fs/promises";
|
import { mkdir, writeFile, readFile, rm, readdir } from "fs/promises";
|
||||||
import { join } from "path";
|
import { join } from "path";
|
||||||
|
|
||||||
const testHomeDir = join(
|
const testHomeDir = join(
|
||||||
@@ -134,7 +134,7 @@ describe("setupClaudeCodeSettings", () => {
|
|||||||
// Then, add new settings
|
// Then, add new settings
|
||||||
const newSettings = JSON.stringify({
|
const newSettings = JSON.stringify({
|
||||||
newKey: "newValue",
|
newKey: "newValue",
|
||||||
model: "claude-opus-4-20250514",
|
model: "claude-opus-4-1-20250805",
|
||||||
});
|
});
|
||||||
|
|
||||||
await setupClaudeCodeSettings(newSettings, testHomeDir);
|
await setupClaudeCodeSettings(newSettings, testHomeDir);
|
||||||
@@ -145,6 +145,74 @@ describe("setupClaudeCodeSettings", () => {
|
|||||||
expect(settings.enableAllProjectMcpServers).toBe(true);
|
expect(settings.enableAllProjectMcpServers).toBe(true);
|
||||||
expect(settings.existingKey).toBe("existingValue");
|
expect(settings.existingKey).toBe("existingValue");
|
||||||
expect(settings.newKey).toBe("newValue");
|
expect(settings.newKey).toBe("newValue");
|
||||||
expect(settings.model).toBe("claude-opus-4-20250514");
|
expect(settings.model).toBe("claude-opus-4-1-20250805");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should copy slash commands to .claude directory when path provided", async () => {
|
||||||
|
const testSlashCommandsDir = join(testHomeDir, "test-slash-commands");
|
||||||
|
await mkdir(testSlashCommandsDir, { recursive: true });
|
||||||
|
await writeFile(
|
||||||
|
join(testSlashCommandsDir, "test-command.md"),
|
||||||
|
"---\ndescription: Test command\n---\nTest content",
|
||||||
|
);
|
||||||
|
|
||||||
|
await setupClaudeCodeSettings(undefined, testHomeDir, testSlashCommandsDir);
|
||||||
|
|
||||||
|
const testCommandPath = join(testHomeDir, ".claude", "test-command.md");
|
||||||
|
const content = await readFile(testCommandPath, "utf-8");
|
||||||
|
expect(content).toContain("Test content");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should skip slash commands when no directory provided", async () => {
|
||||||
|
await setupClaudeCodeSettings(undefined, testHomeDir);
|
||||||
|
|
||||||
|
const settingsContent = await readFile(settingsPath, "utf-8");
|
||||||
|
const settings = JSON.parse(settingsContent);
|
||||||
|
expect(settings.enableAllProjectMcpServers).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should handle missing slash commands directory gracefully", async () => {
|
||||||
|
const nonExistentDir = join(testHomeDir, "non-existent");
|
||||||
|
|
||||||
|
await setupClaudeCodeSettings(undefined, testHomeDir, nonExistentDir);
|
||||||
|
|
||||||
|
const settingsContent = await readFile(settingsPath, "utf-8");
|
||||||
|
expect(JSON.parse(settingsContent).enableAllProjectMcpServers).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should skip non-.md files in slash commands directory", async () => {
|
||||||
|
const testSlashCommandsDir = join(testHomeDir, "test-slash-commands");
|
||||||
|
await mkdir(testSlashCommandsDir, { recursive: true });
|
||||||
|
await writeFile(join(testSlashCommandsDir, "not-markdown.txt"), "ignored");
|
||||||
|
await writeFile(join(testSlashCommandsDir, "valid.md"), "copied");
|
||||||
|
await writeFile(join(testSlashCommandsDir, "another.md"), "also copied");
|
||||||
|
|
||||||
|
await setupClaudeCodeSettings(undefined, testHomeDir, testSlashCommandsDir);
|
||||||
|
|
||||||
|
const copiedFiles = await readdir(join(testHomeDir, ".claude"));
|
||||||
|
expect(copiedFiles).toContain("valid.md");
|
||||||
|
expect(copiedFiles).toContain("another.md");
|
||||||
|
expect(copiedFiles).not.toContain("not-markdown.txt");
|
||||||
|
expect(copiedFiles).toContain("settings.json"); // Settings should also exist
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should handle slash commands path that is a file not directory", async () => {
|
||||||
|
const testFile = join(testHomeDir, "not-a-directory.txt");
|
||||||
|
await writeFile(testFile, "This is a file, not a directory");
|
||||||
|
|
||||||
|
await setupClaudeCodeSettings(undefined, testHomeDir, testFile);
|
||||||
|
|
||||||
|
const settingsContent = await readFile(settingsPath, "utf-8");
|
||||||
|
expect(JSON.parse(settingsContent).enableAllProjectMcpServers).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should handle empty slash commands directory", async () => {
|
||||||
|
const emptyDir = join(testHomeDir, "empty-slash-commands");
|
||||||
|
await mkdir(emptyDir, { recursive: true });
|
||||||
|
|
||||||
|
await setupClaudeCodeSettings(undefined, testHomeDir, emptyDir);
|
||||||
|
|
||||||
|
const settingsContent = await readFile(settingsPath, "utf-8");
|
||||||
|
expect(JSON.parse(settingsContent).enableAllProjectMcpServers).toBe(true);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
33
docs/capabilities-and-limitations.md
Normal file
33
docs/capabilities-and-limitations.md
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
# Capabilities and Limitations
|
||||||
|
|
||||||
|
## What Claude Can Do
|
||||||
|
|
||||||
|
- **Respond in a Single Comment**: Claude operates by updating a single initial comment with progress and results
|
||||||
|
- **Answer Questions**: Analyze code and provide explanations
|
||||||
|
- **Implement Code Changes**: Make simple to moderate code changes based on requests
|
||||||
|
- **Prepare Pull Requests**: Creates commits on a branch and links back to a prefilled PR creation page
|
||||||
|
- **Perform Code Reviews**: Analyze PR changes and provide detailed feedback
|
||||||
|
- **Smart Branch Handling**:
|
||||||
|
- When triggered on an **issue**: Always creates a new branch for the work
|
||||||
|
- When triggered on an **open PR**: Always pushes directly to the existing PR branch
|
||||||
|
- When triggered on a **closed PR**: Creates a new branch since the original is no longer active
|
||||||
|
- **View GitHub Actions Results**: Can access workflow runs, job logs, and test results on the PR where it's tagged when `actions: read` permission is configured (see [Additional Permissions for CI/CD Integration](./configuration.md#additional-permissions-for-cicd-integration))
|
||||||
|
|
||||||
|
## What Claude Cannot Do
|
||||||
|
|
||||||
|
- **Submit PR Reviews**: Claude cannot submit formal GitHub PR reviews
|
||||||
|
- **Approve PRs**: For security reasons, Claude cannot approve pull requests
|
||||||
|
- **Post Multiple Comments**: Claude only acts by updating its initial comment
|
||||||
|
- **Execute Commands Outside Its Context**: Claude only has access to the repository and PR/issue context it's triggered in
|
||||||
|
- **Run Arbitrary Bash Commands**: By default, Claude cannot execute Bash commands unless explicitly allowed using the `allowed_tools` configuration
|
||||||
|
- **Perform Branch Operations**: Cannot merge branches, rebase, or perform other git operations beyond pushing commits
|
||||||
|
|
||||||
|
## How It Works
|
||||||
|
|
||||||
|
1. **Trigger Detection**: Listens for comments containing the trigger phrase (default: `@claude`) or issue assignment to a specific user
|
||||||
|
2. **Context Gathering**: Analyzes the PR/issue, comments, code changes
|
||||||
|
3. **Smart Responses**: Either answers questions or implements changes
|
||||||
|
4. **Branch Management**: Creates new PRs for human authors, pushes directly for Claude's own PRs
|
||||||
|
5. **Communication**: Posts updates at every step to keep you informed
|
||||||
|
|
||||||
|
This action is built on top of [`anthropics/claude-code-base-action`](https://github.com/anthropics/claude-code-base-action).
|
||||||
95
docs/cloud-providers.md
Normal file
95
docs/cloud-providers.md
Normal file
@@ -0,0 +1,95 @@
|
|||||||
|
# Cloud Providers
|
||||||
|
|
||||||
|
You can authenticate with Claude using any of these three methods:
|
||||||
|
|
||||||
|
1. Direct Anthropic API (default)
|
||||||
|
2. Amazon Bedrock with OIDC authentication
|
||||||
|
3. Google Vertex AI with OIDC authentication
|
||||||
|
|
||||||
|
For detailed setup instructions for AWS Bedrock and Google Vertex AI, see the [official documentation](https://docs.anthropic.com/en/docs/claude-code/github-actions#using-with-aws-bedrock-%26-google-vertex-ai).
|
||||||
|
|
||||||
|
**Note**:
|
||||||
|
|
||||||
|
- Bedrock and Vertex use OIDC authentication exclusively
|
||||||
|
- AWS Bedrock automatically uses cross-region inference profiles for certain models
|
||||||
|
- For cross-region inference profile models, you need to request and be granted access to the Claude models in all regions that the inference profile uses
|
||||||
|
|
||||||
|
## Model Configuration
|
||||||
|
|
||||||
|
Use provider-specific model names based on your chosen provider:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# For direct Anthropic API (default)
|
||||||
|
- uses: anthropics/claude-code-action@beta
|
||||||
|
with:
|
||||||
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
|
# ... other inputs
|
||||||
|
|
||||||
|
# For Amazon Bedrock with OIDC
|
||||||
|
- uses: anthropics/claude-code-action@beta
|
||||||
|
with:
|
||||||
|
model: "anthropic.claude-3-7-sonnet-20250219-beta:0" # Cross-region inference
|
||||||
|
use_bedrock: "true"
|
||||||
|
# ... other inputs
|
||||||
|
|
||||||
|
# For Google Vertex AI with OIDC
|
||||||
|
- uses: anthropics/claude-code-action@beta
|
||||||
|
with:
|
||||||
|
model: "claude-3-7-sonnet@20250219"
|
||||||
|
use_vertex: "true"
|
||||||
|
# ... other inputs
|
||||||
|
```
|
||||||
|
|
||||||
|
## OIDC Authentication for Bedrock and Vertex
|
||||||
|
|
||||||
|
Both AWS Bedrock and GCP Vertex AI require OIDC authentication.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# For AWS Bedrock with OIDC
|
||||||
|
- name: Configure AWS Credentials (OIDC)
|
||||||
|
uses: aws-actions/configure-aws-credentials@v4
|
||||||
|
with:
|
||||||
|
role-to-assume: ${{ secrets.AWS_ROLE_TO_ASSUME }}
|
||||||
|
aws-region: us-west-2
|
||||||
|
|
||||||
|
- name: Generate GitHub App token
|
||||||
|
id: app-token
|
||||||
|
uses: actions/create-github-app-token@v2
|
||||||
|
with:
|
||||||
|
app-id: ${{ secrets.APP_ID }}
|
||||||
|
private-key: ${{ secrets.APP_PRIVATE_KEY }}
|
||||||
|
|
||||||
|
- uses: anthropics/claude-code-action@beta
|
||||||
|
with:
|
||||||
|
model: "anthropic.claude-3-7-sonnet-20250219-beta:0"
|
||||||
|
use_bedrock: "true"
|
||||||
|
# ... other inputs
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
id-token: write # Required for OIDC
|
||||||
|
```
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# For GCP Vertex AI with OIDC
|
||||||
|
- name: Authenticate to Google Cloud
|
||||||
|
uses: google-github-actions/auth@v2
|
||||||
|
with:
|
||||||
|
workload_identity_provider: ${{ secrets.GCP_WORKLOAD_IDENTITY_PROVIDER }}
|
||||||
|
service_account: ${{ secrets.GCP_SERVICE_ACCOUNT }}
|
||||||
|
|
||||||
|
- name: Generate GitHub App token
|
||||||
|
id: app-token
|
||||||
|
uses: actions/create-github-app-token@v2
|
||||||
|
with:
|
||||||
|
app-id: ${{ secrets.APP_ID }}
|
||||||
|
private-key: ${{ secrets.APP_PRIVATE_KEY }}
|
||||||
|
|
||||||
|
- uses: anthropics/claude-code-action@beta
|
||||||
|
with:
|
||||||
|
model: "claude-3-7-sonnet@20250219"
|
||||||
|
use_vertex: "true"
|
||||||
|
# ... other inputs
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
id-token: write # Required for OIDC
|
||||||
|
```
|
||||||
285
docs/configuration.md
Normal file
285
docs/configuration.md
Normal file
@@ -0,0 +1,285 @@
|
|||||||
|
# Advanced Configuration
|
||||||
|
|
||||||
|
## Using Custom MCP Configuration
|
||||||
|
|
||||||
|
The `mcp_config` input allows you to add custom MCP (Model Context Protocol) servers to extend Claude's capabilities. These servers merge with the built-in GitHub MCP servers.
|
||||||
|
|
||||||
|
### Basic Example: Adding a Sequential Thinking Server
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: anthropics/claude-code-action@beta
|
||||||
|
with:
|
||||||
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
|
mcp_config: |
|
||||||
|
{
|
||||||
|
"mcpServers": {
|
||||||
|
"sequential-thinking": {
|
||||||
|
"command": "npx",
|
||||||
|
"args": [
|
||||||
|
"-y",
|
||||||
|
"@modelcontextprotocol/server-sequential-thinking"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
allowed_tools: "mcp__sequential-thinking__sequentialthinking" # Important: Each MCP tool from your server must be listed here, comma-separated
|
||||||
|
# ... other inputs
|
||||||
|
```
|
||||||
|
|
||||||
|
### Passing Secrets to MCP Servers
|
||||||
|
|
||||||
|
For MCP servers that require sensitive information like API keys or tokens, use GitHub Secrets in the environment variables:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: anthropics/claude-code-action@beta
|
||||||
|
with:
|
||||||
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
|
mcp_config: |
|
||||||
|
{
|
||||||
|
"mcpServers": {
|
||||||
|
"custom-api-server": {
|
||||||
|
"command": "npx",
|
||||||
|
"args": ["-y", "@example/api-server"],
|
||||||
|
"env": {
|
||||||
|
"API_KEY": "${{ secrets.CUSTOM_API_KEY }}",
|
||||||
|
"BASE_URL": "https://api.example.com"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
# ... other inputs
|
||||||
|
```
|
||||||
|
|
||||||
|
### Using Python MCP Servers with uv
|
||||||
|
|
||||||
|
For Python-based MCP servers managed with `uv`, you need to specify the directory containing your server:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: anthropics/claude-code-action@beta
|
||||||
|
with:
|
||||||
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
|
mcp_config: |
|
||||||
|
{
|
||||||
|
"mcpServers": {
|
||||||
|
"my-python-server": {
|
||||||
|
"type": "stdio",
|
||||||
|
"command": "uv",
|
||||||
|
"args": [
|
||||||
|
"--directory",
|
||||||
|
"${{ github.workspace }}/path/to/server/",
|
||||||
|
"run",
|
||||||
|
"server_file.py"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
allowed_tools: "my-python-server__<tool_name>" # Replace <tool_name> with your server's tool names
|
||||||
|
# ... other inputs
|
||||||
|
```
|
||||||
|
|
||||||
|
For example, if your Python MCP server is at `mcp_servers/weather.py`, you would use:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
"args":
|
||||||
|
["--directory", "${{ github.workspace }}/mcp_servers/", "run", "weather.py"]
|
||||||
|
```
|
||||||
|
|
||||||
|
**Important**:
|
||||||
|
|
||||||
|
- Always use GitHub Secrets (`${{ secrets.SECRET_NAME }}`) for sensitive values like API keys, tokens, or passwords. Never hardcode secrets directly in the workflow file.
|
||||||
|
- Your custom servers will override any built-in servers with the same name.
|
||||||
|
|
||||||
|
## Additional Permissions for CI/CD Integration
|
||||||
|
|
||||||
|
The `additional_permissions` input allows Claude to access GitHub Actions workflow information when you grant the necessary permissions. This is particularly useful for analyzing CI/CD failures and debugging workflow issues.
|
||||||
|
|
||||||
|
### Enabling GitHub Actions Access
|
||||||
|
|
||||||
|
To allow Claude to view workflow run results, job logs, and CI status:
|
||||||
|
|
||||||
|
1. **Grant the necessary permission to your GitHub token**:
|
||||||
|
|
||||||
|
- When using the default `GITHUB_TOKEN`, add the `actions: read` permission to your workflow:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
permissions:
|
||||||
|
contents: write
|
||||||
|
pull-requests: write
|
||||||
|
issues: write
|
||||||
|
actions: read # Add this line
|
||||||
|
```
|
||||||
|
|
||||||
|
2. **Configure the action with additional permissions**:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: anthropics/claude-code-action@beta
|
||||||
|
with:
|
||||||
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
|
additional_permissions: |
|
||||||
|
actions: read
|
||||||
|
# ... other inputs
|
||||||
|
```
|
||||||
|
|
||||||
|
3. **Claude will automatically get access to CI/CD tools**:
|
||||||
|
When you enable `actions: read`, Claude can use the following MCP tools:
|
||||||
|
- `mcp__github_ci__get_ci_status` - View workflow run statuses
|
||||||
|
- `mcp__github_ci__get_workflow_run_details` - Get detailed workflow information
|
||||||
|
- `mcp__github_ci__download_job_log` - Download and analyze job logs
|
||||||
|
|
||||||
|
### Example: Debugging Failed CI Runs
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
name: Claude CI Helper
|
||||||
|
on:
|
||||||
|
issue_comment:
|
||||||
|
types: [created]
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: write
|
||||||
|
pull-requests: write
|
||||||
|
issues: write
|
||||||
|
actions: read # Required for CI access
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
claude-ci-helper:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: anthropics/claude-code-action@beta
|
||||||
|
with:
|
||||||
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
|
additional_permissions: |
|
||||||
|
actions: read
|
||||||
|
# Now Claude can respond to "@claude why did the CI fail?"
|
||||||
|
```
|
||||||
|
|
||||||
|
**Important Notes**:
|
||||||
|
|
||||||
|
- The GitHub token must have the `actions: read` permission in your workflow
|
||||||
|
- If the permission is missing, Claude will warn you and suggest adding it
|
||||||
|
- Currently, only `actions: read` is supported, but the format allows for future extensions
|
||||||
|
|
||||||
|
## Custom Environment Variables
|
||||||
|
|
||||||
|
You can pass custom environment variables to Claude Code execution using the `claude_env` input. This is useful for CI/test setups that require specific environment variables:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: anthropics/claude-code-action@beta
|
||||||
|
with:
|
||||||
|
claude_env: |
|
||||||
|
NODE_ENV: test
|
||||||
|
CI: true
|
||||||
|
DATABASE_URL: postgres://test:test@localhost:5432/test_db
|
||||||
|
# ... other inputs
|
||||||
|
```
|
||||||
|
|
||||||
|
The `claude_env` input accepts YAML format where each line defines a key-value pair. These environment variables will be available to Claude Code during execution, allowing it to run tests, build processes, or other commands that depend on specific environment configurations.
|
||||||
|
|
||||||
|
## Limiting Conversation Turns
|
||||||
|
|
||||||
|
You can use the `max_turns` parameter to limit the number of back-and-forth exchanges Claude can have during task execution. This is useful for:
|
||||||
|
|
||||||
|
- Controlling costs by preventing runaway conversations
|
||||||
|
- Setting time boundaries for automated workflows
|
||||||
|
- Ensuring predictable behavior in CI/CD pipelines
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: anthropics/claude-code-action@beta
|
||||||
|
with:
|
||||||
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
|
max_turns: "5" # Limit to 5 conversation turns
|
||||||
|
# ... other inputs
|
||||||
|
```
|
||||||
|
|
||||||
|
When the turn limit is reached, Claude will stop execution gracefully. Choose a value that gives Claude enough turns to complete typical tasks while preventing excessive usage.
|
||||||
|
|
||||||
|
## Custom Tools
|
||||||
|
|
||||||
|
By default, Claude only has access to:
|
||||||
|
|
||||||
|
- File operations (reading, committing, editing files, read-only git commands)
|
||||||
|
- Comment management (creating/updating comments)
|
||||||
|
- Basic GitHub operations
|
||||||
|
|
||||||
|
Claude does **not** have access to execute arbitrary Bash commands by default. If you want Claude to run specific commands (e.g., npm install, npm test), you must explicitly allow them using the `allowed_tools` configuration:
|
||||||
|
|
||||||
|
**Note**: If your repository has a `.mcp.json` file in the root directory, Claude will automatically detect and use the MCP server tools defined there. However, these tools still need to be explicitly allowed via the `allowed_tools` configuration.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: anthropics/claude-code-action@beta
|
||||||
|
with:
|
||||||
|
allowed_tools: "Bash(npm install),Bash(npm run test),Edit,Replace,NotebookEditCell"
|
||||||
|
disallowed_tools: "TaskOutput,KillTask"
|
||||||
|
# ... other inputs
|
||||||
|
```
|
||||||
|
|
||||||
|
**Note**: The base GitHub tools are always included. Use `allowed_tools` to add additional tools (including specific Bash commands), and `disallowed_tools` to prevent specific tools from being used.
|
||||||
|
|
||||||
|
## Custom Model
|
||||||
|
|
||||||
|
Use a specific Claude model:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: anthropics/claude-code-action@beta
|
||||||
|
with:
|
||||||
|
# model: "claude-3-5-sonnet-20241022" # Optional: specify a different model
|
||||||
|
# ... other inputs
|
||||||
|
```
|
||||||
|
|
||||||
|
## Claude Code Settings
|
||||||
|
|
||||||
|
You can provide Claude Code settings to customize behavior such as model selection, environment variables, permissions, and hooks. Settings can be provided either as a JSON string or a path to a settings file.
|
||||||
|
|
||||||
|
### Option 1: Settings File
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: anthropics/claude-code-action@beta
|
||||||
|
with:
|
||||||
|
settings: "path/to/settings.json"
|
||||||
|
# ... other inputs
|
||||||
|
```
|
||||||
|
|
||||||
|
### Option 2: Inline Settings
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: anthropics/claude-code-action@beta
|
||||||
|
with:
|
||||||
|
settings: |
|
||||||
|
{
|
||||||
|
"model": "claude-opus-4-1-20250805",
|
||||||
|
"env": {
|
||||||
|
"DEBUG": "true",
|
||||||
|
"API_URL": "https://api.example.com"
|
||||||
|
},
|
||||||
|
"permissions": {
|
||||||
|
"allow": ["Bash", "Read"],
|
||||||
|
"deny": ["WebFetch"]
|
||||||
|
},
|
||||||
|
"hooks": {
|
||||||
|
"PreToolUse": [{
|
||||||
|
"matcher": "Bash",
|
||||||
|
"hooks": [{
|
||||||
|
"type": "command",
|
||||||
|
"command": "echo Running bash command..."
|
||||||
|
}]
|
||||||
|
}]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
# ... other inputs
|
||||||
|
```
|
||||||
|
|
||||||
|
The settings support all Claude Code settings options including:
|
||||||
|
|
||||||
|
- `model`: Override the default model
|
||||||
|
- `env`: Environment variables for the session
|
||||||
|
- `permissions`: Tool usage permissions
|
||||||
|
- `hooks`: Pre/post tool execution hooks
|
||||||
|
- And more...
|
||||||
|
|
||||||
|
For a complete list of available settings and their descriptions, see the [Claude Code settings documentation](https://docs.anthropic.com/en/docs/claude-code/settings).
|
||||||
|
|
||||||
|
**Notes**:
|
||||||
|
|
||||||
|
- The `enableAllProjectMcpServers` setting is always set to `true` by this action to ensure MCP servers work correctly.
|
||||||
|
- If both the `model` input parameter and a `model` in settings are provided, the `model` input parameter takes precedence.
|
||||||
|
- The `allowed_tools` and `disallowed_tools` input parameters take precedence over `permissions` in settings.
|
||||||
|
- In a future version, we may deprecate individual input parameters in favor of using the settings file for all configuration.
|
||||||
91
docs/custom-automations.md
Normal file
91
docs/custom-automations.md
Normal file
@@ -0,0 +1,91 @@
|
|||||||
|
# Custom Automations
|
||||||
|
|
||||||
|
These examples show how to configure Claude to act automatically based on GitHub events, without requiring manual @mentions.
|
||||||
|
|
||||||
|
## Supported GitHub Events
|
||||||
|
|
||||||
|
This action supports the following GitHub events ([learn more GitHub event triggers](https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows)):
|
||||||
|
|
||||||
|
- `pull_request` - When PRs are opened or synchronized
|
||||||
|
- `issue_comment` - When comments are created on issues or PRs
|
||||||
|
- `pull_request_comment` - When comments are made on PR diffs
|
||||||
|
- `issues` - When issues are opened or assigned
|
||||||
|
- `pull_request_review` - When PR reviews are submitted
|
||||||
|
- `pull_request_review_comment` - When comments are made on PR reviews
|
||||||
|
- `repository_dispatch` - Custom events triggered via API (coming soon)
|
||||||
|
- `workflow_dispatch` - Manual workflow triggers (coming soon)
|
||||||
|
|
||||||
|
## Automated Documentation Updates
|
||||||
|
|
||||||
|
Automatically update documentation when specific files change (see [`examples/claude-pr-path-specific.yml`](../examples/claude-pr-path-specific.yml)):
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
on:
|
||||||
|
pull_request:
|
||||||
|
paths:
|
||||||
|
- "src/api/**/*.ts"
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: anthropics/claude-code-action@beta
|
||||||
|
with:
|
||||||
|
direct_prompt: |
|
||||||
|
Update the API documentation in README.md to reflect
|
||||||
|
the changes made to the API endpoints in this PR.
|
||||||
|
```
|
||||||
|
|
||||||
|
When API files are modified, Claude automatically updates your README with the latest endpoint documentation and pushes the changes back to the PR, keeping your docs in sync with your code.
|
||||||
|
|
||||||
|
## Author-Specific Code Reviews
|
||||||
|
|
||||||
|
Automatically review PRs from specific authors or external contributors (see [`examples/claude-review-from-author.yml`](../examples/claude-review-from-author.yml)):
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
on:
|
||||||
|
pull_request:
|
||||||
|
types: [opened, synchronize]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
review-by-author:
|
||||||
|
if: |
|
||||||
|
github.event.pull_request.user.login == 'developer1' ||
|
||||||
|
github.event.pull_request.user.login == 'external-contributor'
|
||||||
|
steps:
|
||||||
|
- uses: anthropics/claude-code-action@beta
|
||||||
|
with:
|
||||||
|
direct_prompt: |
|
||||||
|
Please provide a thorough review of this pull request.
|
||||||
|
Pay extra attention to coding standards, security practices,
|
||||||
|
and test coverage since this is from an external contributor.
|
||||||
|
```
|
||||||
|
|
||||||
|
Perfect for automatically reviewing PRs from new team members, external contributors, or specific developers who need extra guidance.
|
||||||
|
|
||||||
|
## Custom Prompt Templates
|
||||||
|
|
||||||
|
Use `override_prompt` for complete control over Claude's behavior with variable substitution:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: anthropics/claude-code-action@beta
|
||||||
|
with:
|
||||||
|
override_prompt: |
|
||||||
|
Analyze PR #$PR_NUMBER in $REPOSITORY for security vulnerabilities.
|
||||||
|
|
||||||
|
Changed files:
|
||||||
|
$CHANGED_FILES
|
||||||
|
|
||||||
|
Focus on:
|
||||||
|
- SQL injection risks
|
||||||
|
- XSS vulnerabilities
|
||||||
|
- Authentication bypasses
|
||||||
|
- Exposed secrets or credentials
|
||||||
|
|
||||||
|
Provide severity ratings (Critical/High/Medium/Low) for any issues found.
|
||||||
|
```
|
||||||
|
|
||||||
|
The `override_prompt` feature supports these variables:
|
||||||
|
|
||||||
|
- `$REPOSITORY`, `$PR_NUMBER`, `$ISSUE_NUMBER`
|
||||||
|
- `$PR_TITLE`, `$ISSUE_TITLE`, `$PR_BODY`, `$ISSUE_BODY`
|
||||||
|
- `$PR_COMMENTS`, `$ISSUE_COMMENTS`, `$REVIEW_COMMENTS`
|
||||||
|
- `$CHANGED_FILES`, `$TRIGGER_COMMENT`, `$TRIGGER_USERNAME`
|
||||||
|
- `$BRANCH_NAME`, `$BASE_BRANCH`, `$EVENT_TYPE`, `$IS_PR`
|
||||||
127
docs/experimental.md
Normal file
127
docs/experimental.md
Normal file
@@ -0,0 +1,127 @@
|
|||||||
|
# Experimental Features
|
||||||
|
|
||||||
|
**Note:** Experimental features are considered unstable and not supported for production use. They may change or be removed at any time.
|
||||||
|
|
||||||
|
## Execution Modes
|
||||||
|
|
||||||
|
The action supports three execution modes, each optimized for different use cases:
|
||||||
|
|
||||||
|
### Tag Mode (Default)
|
||||||
|
|
||||||
|
The traditional implementation mode that responds to @claude mentions, issue assignments, or labels.
|
||||||
|
|
||||||
|
- **Triggers**: `@claude` mentions, issue assignment, label application
|
||||||
|
- **Features**: Creates tracking comments with progress checkboxes, full implementation capabilities
|
||||||
|
- **Use case**: General-purpose code implementation and Q&A
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: anthropics/claude-code-action@beta
|
||||||
|
with:
|
||||||
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
|
# mode: tag is the default
|
||||||
|
```
|
||||||
|
|
||||||
|
### Agent Mode
|
||||||
|
|
||||||
|
**Note: Agent mode is currently in active development and may undergo breaking changes.**
|
||||||
|
|
||||||
|
For automation with workflow_dispatch and scheduled events only.
|
||||||
|
|
||||||
|
- **Triggers**: Only works with `workflow_dispatch` and `schedule` events - does NOT work with PR/issue events
|
||||||
|
- **Features**: Perfect for scheduled tasks, works with `override_prompt`
|
||||||
|
- **Use case**: Maintenance tasks, automated reporting, scheduled checks
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: anthropics/claude-code-action@beta
|
||||||
|
with:
|
||||||
|
mode: agent
|
||||||
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
|
override_prompt: |
|
||||||
|
Check for outdated dependencies and create an issue if any are found.
|
||||||
|
```
|
||||||
|
|
||||||
|
### Experimental Review Mode
|
||||||
|
|
||||||
|
**Warning: This is an experimental feature that may change or be removed at any time.**
|
||||||
|
|
||||||
|
For automated code reviews on pull requests.
|
||||||
|
|
||||||
|
- **Triggers**: Pull request events (`opened`, `synchronize`) or `@claude review` comments
|
||||||
|
- **Features**: Provides detailed code reviews with inline comments and suggestions
|
||||||
|
- **Use case**: Automated PR reviews, code quality checks
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: anthropics/claude-code-action@beta
|
||||||
|
with:
|
||||||
|
mode: experimental-review
|
||||||
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
|
custom_instructions: |
|
||||||
|
Focus on code quality, security, and best practices.
|
||||||
|
```
|
||||||
|
|
||||||
|
See [`examples/claude-modes.yml`](../examples/claude-modes.yml) and [`examples/claude-experimental-review-mode.yml`](../examples/claude-experimental-review-mode.yml) for complete examples of each mode.
|
||||||
|
|
||||||
|
## Network Restrictions
|
||||||
|
|
||||||
|
For enhanced security, you can restrict Claude's network access to specific domains only. This feature is particularly useful for:
|
||||||
|
|
||||||
|
- Enterprise environments with strict security policies
|
||||||
|
- Preventing access to external services
|
||||||
|
- Limiting Claude to only your internal APIs and services
|
||||||
|
|
||||||
|
When `experimental_allowed_domains` is set, Claude can only access the domains you explicitly list. You'll need to include the appropriate provider domains based on your authentication method.
|
||||||
|
|
||||||
|
### Provider-Specific Examples
|
||||||
|
|
||||||
|
#### If using Anthropic API or subscription
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: anthropics/claude-code-action@beta
|
||||||
|
with:
|
||||||
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
|
# Or: claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
|
||||||
|
experimental_allowed_domains: |
|
||||||
|
.anthropic.com
|
||||||
|
```
|
||||||
|
|
||||||
|
#### If using AWS Bedrock
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: anthropics/claude-code-action@beta
|
||||||
|
with:
|
||||||
|
use_bedrock: "true"
|
||||||
|
experimental_allowed_domains: |
|
||||||
|
bedrock.*.amazonaws.com
|
||||||
|
bedrock-runtime.*.amazonaws.com
|
||||||
|
```
|
||||||
|
|
||||||
|
#### If using Google Vertex AI
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: anthropics/claude-code-action@beta
|
||||||
|
with:
|
||||||
|
use_vertex: "true"
|
||||||
|
experimental_allowed_domains: |
|
||||||
|
*.googleapis.com
|
||||||
|
vertexai.googleapis.com
|
||||||
|
```
|
||||||
|
|
||||||
|
### Common GitHub Domains
|
||||||
|
|
||||||
|
In addition to your provider domains, you may need to include GitHub-related domains. For GitHub.com users, common domains include:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: anthropics/claude-code-action@beta
|
||||||
|
with:
|
||||||
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
|
experimental_allowed_domains: |
|
||||||
|
.anthropic.com # For Anthropic API
|
||||||
|
.github.com
|
||||||
|
.githubusercontent.com
|
||||||
|
ghcr.io
|
||||||
|
.blob.core.windows.net
|
||||||
|
```
|
||||||
|
|
||||||
|
For GitHub Enterprise users, replace the GitHub.com domains above with your enterprise domains (e.g., `.github.company.com`, `packages.company.com`, etc.).
|
||||||
|
|
||||||
|
To determine which domains your workflow needs, you can temporarily run without restrictions and monitor the network requests, or check your GitHub Enterprise configuration for the specific services you use.
|
||||||
@@ -135,6 +135,14 @@ allowed_tools: "Bash(npm:*),Bash(git:*)" # Allows only npm and git commands
|
|||||||
|
|
||||||
No, Claude's GitHub app token is sandboxed to the current repository only. It cannot push to any other repositories. It can, however, read public repositories, but to get access to this, you must configure it with tools to do so.
|
No, Claude's GitHub app token is sandboxed to the current repository only. It cannot push to any other repositories. It can, however, read public repositories, but to get access to this, you must configure it with tools to do so.
|
||||||
|
|
||||||
|
### Why aren't comments posted as claude[bot]?
|
||||||
|
|
||||||
|
Comments appear as claude[bot] when the action uses its built-in authentication. However, if you provide a `github_token` in your workflow, the action will use that token's authentication instead, causing comments to appear under a different username.
|
||||||
|
|
||||||
|
**Solution**: Remove `github_token` from your workflow file unless you're using a custom GitHub App.
|
||||||
|
|
||||||
|
**Note**: The `use_sticky_comment` feature only works with claude[bot] authentication. If you're using a custom `github_token`, sticky comments won't update properly since they expect the claude[bot] username.
|
||||||
|
|
||||||
## MCP Servers and Extended Functionality
|
## MCP Servers and Extended Functionality
|
||||||
|
|
||||||
### What MCP servers are available by default?
|
### What MCP servers are available by default?
|
||||||
38
docs/security.md
Normal file
38
docs/security.md
Normal file
@@ -0,0 +1,38 @@
|
|||||||
|
# Security
|
||||||
|
|
||||||
|
## Access Control
|
||||||
|
|
||||||
|
- **Repository Access**: The action can only be triggered by users with write access to the repository
|
||||||
|
- **Bot User Control**: By default, GitHub Apps and bots cannot trigger this action for security reasons. Use the `allowed_bots` parameter to enable specific bots or all bots
|
||||||
|
- **Token Permissions**: The GitHub app receives only a short-lived token scoped specifically to the repository it's operating in
|
||||||
|
- **No Cross-Repository Access**: Each action invocation is limited to the repository where it was triggered
|
||||||
|
- **Limited Scope**: The token cannot access other repositories or perform actions beyond the configured permissions
|
||||||
|
|
||||||
|
## GitHub App Permissions
|
||||||
|
|
||||||
|
The [Claude Code GitHub app](https://github.com/apps/claude) requires these permissions:
|
||||||
|
|
||||||
|
- **Pull Requests**: Read and write to create PRs and push changes
|
||||||
|
- **Issues**: Read and write to respond to issues
|
||||||
|
- **Contents**: Read and write to modify repository files
|
||||||
|
|
||||||
|
## Commit Signing
|
||||||
|
|
||||||
|
All commits made by Claude through this action are automatically signed with commit signatures. This ensures the authenticity and integrity of commits, providing a verifiable trail of changes made by the action.
|
||||||
|
|
||||||
|
## ⚠️ Authentication Protection
|
||||||
|
|
||||||
|
**CRITICAL: Never hardcode your Anthropic API key or OAuth token in workflow files!**
|
||||||
|
|
||||||
|
Your authentication credentials must always be stored in GitHub secrets to prevent unauthorized access:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# CORRECT ✅
|
||||||
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
|
# OR
|
||||||
|
claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
|
||||||
|
|
||||||
|
# NEVER DO THIS ❌
|
||||||
|
anthropic_api_key: "sk-ant-api03-..." # Exposed and vulnerable!
|
||||||
|
claude_code_oauth_token: "oauth_token_..." # Exposed and vulnerable!
|
||||||
|
```
|
||||||
146
docs/setup.md
Normal file
146
docs/setup.md
Normal file
@@ -0,0 +1,146 @@
|
|||||||
|
# Setup Guide
|
||||||
|
|
||||||
|
## Manual Setup (Direct API)
|
||||||
|
|
||||||
|
**Requirements**: You must be a repository admin to complete these steps.
|
||||||
|
|
||||||
|
1. Install the Claude GitHub app to your repository: https://github.com/apps/claude
|
||||||
|
2. Add authentication to your repository secrets ([Learn how to use secrets in GitHub Actions](https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions)):
|
||||||
|
- Either `ANTHROPIC_API_KEY` for API key authentication
|
||||||
|
- Or `CLAUDE_CODE_OAUTH_TOKEN` for OAuth token authentication (Pro and Max users can generate this by running `claude setup-token` locally)
|
||||||
|
3. Copy the workflow file from [`examples/claude.yml`](../examples/claude.yml) into your repository's `.github/workflows/`
|
||||||
|
|
||||||
|
## Using a Custom GitHub App
|
||||||
|
|
||||||
|
If you prefer not to install the official Claude app, you can create your own GitHub App to use with this action. This gives you complete control over permissions and access.
|
||||||
|
|
||||||
|
**When you may want to use a custom GitHub App:**
|
||||||
|
|
||||||
|
- You need more restrictive permissions than the official app
|
||||||
|
- Organization policies prevent installing third-party apps
|
||||||
|
- You're using AWS Bedrock or Google Vertex AI
|
||||||
|
|
||||||
|
**Steps to create and use a custom GitHub App:**
|
||||||
|
|
||||||
|
1. **Create a new GitHub App:**
|
||||||
|
|
||||||
|
- Go to https://github.com/settings/apps (for personal apps) or your organization's settings
|
||||||
|
- Click "New GitHub App"
|
||||||
|
- Configure the app with these minimum permissions:
|
||||||
|
- **Repository permissions:**
|
||||||
|
- Contents: Read & Write
|
||||||
|
- Issues: Read & Write
|
||||||
|
- Pull requests: Read & Write
|
||||||
|
- **Account permissions:** None required
|
||||||
|
- Set "Where can this GitHub App be installed?" to your preference
|
||||||
|
- Create the app
|
||||||
|
|
||||||
|
2. **Generate and download a private key:**
|
||||||
|
|
||||||
|
- After creating the app, scroll down to "Private keys"
|
||||||
|
- Click "Generate a private key"
|
||||||
|
- Download the `.pem` file (keep this secure!)
|
||||||
|
|
||||||
|
3. **Install the app on your repository:**
|
||||||
|
|
||||||
|
- Go to the app's settings page
|
||||||
|
- Click "Install App"
|
||||||
|
- Select the repositories where you want to use Claude
|
||||||
|
|
||||||
|
4. **Add the app credentials to your repository secrets:**
|
||||||
|
|
||||||
|
- Go to your repository's Settings → Secrets and variables → Actions
|
||||||
|
- Add these secrets:
|
||||||
|
- `APP_ID`: Your GitHub App's ID (found in the app settings)
|
||||||
|
- `APP_PRIVATE_KEY`: The contents of the downloaded `.pem` file
|
||||||
|
|
||||||
|
5. **Update your workflow to use the custom app:**
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
name: Claude with Custom App
|
||||||
|
on:
|
||||||
|
issue_comment:
|
||||||
|
types: [created]
|
||||||
|
# ... other triggers
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
claude-response:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
# Generate a token from your custom app
|
||||||
|
- name: Generate GitHub App token
|
||||||
|
id: app-token
|
||||||
|
uses: actions/create-github-app-token@v1
|
||||||
|
with:
|
||||||
|
app-id: ${{ secrets.APP_ID }}
|
||||||
|
private-key: ${{ secrets.APP_PRIVATE_KEY }}
|
||||||
|
|
||||||
|
# Use Claude with your custom app's token
|
||||||
|
- uses: anthropics/claude-code-action@beta
|
||||||
|
with:
|
||||||
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
|
github_token: ${{ steps.app-token.outputs.token }}
|
||||||
|
# ... other configuration
|
||||||
|
```
|
||||||
|
|
||||||
|
**Important notes:**
|
||||||
|
|
||||||
|
- The custom app must have read/write permissions for Issues, Pull Requests, and Contents
|
||||||
|
- Your app's token will have the exact permissions you configured, nothing more
|
||||||
|
|
||||||
|
For more information on creating GitHub Apps, see the [GitHub documentation](https://docs.github.com/en/apps/creating-github-apps).
|
||||||
|
|
||||||
|
## Security Best Practices
|
||||||
|
|
||||||
|
**⚠️ IMPORTANT: Never commit API keys directly to your repository! Always use GitHub Actions secrets.**
|
||||||
|
|
||||||
|
To securely use your Anthropic API key:
|
||||||
|
|
||||||
|
1. Add your API key as a repository secret:
|
||||||
|
|
||||||
|
- Go to your repository's Settings
|
||||||
|
- Navigate to "Secrets and variables" → "Actions"
|
||||||
|
- Click "New repository secret"
|
||||||
|
- Name it `ANTHROPIC_API_KEY`
|
||||||
|
- Paste your API key as the value
|
||||||
|
|
||||||
|
2. Reference the secret in your workflow:
|
||||||
|
```yaml
|
||||||
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Never do this:**
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# ❌ WRONG - Exposes your API key
|
||||||
|
anthropic_api_key: "sk-ant-..."
|
||||||
|
```
|
||||||
|
|
||||||
|
**Always do this:**
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# ✅ CORRECT - Uses GitHub secrets
|
||||||
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
|
```
|
||||||
|
|
||||||
|
This applies to all sensitive values including API keys, access tokens, and credentials.
|
||||||
|
We also recommend that you always use short-lived tokens when possible
|
||||||
|
|
||||||
|
## Setting Up GitHub Secrets
|
||||||
|
|
||||||
|
1. Go to your repository's Settings
|
||||||
|
2. Click on "Secrets and variables" → "Actions"
|
||||||
|
3. Click "New repository secret"
|
||||||
|
4. For authentication, choose one:
|
||||||
|
- API Key: Name: `ANTHROPIC_API_KEY`, Value: Your Anthropic API key (starting with `sk-ant-`)
|
||||||
|
- OAuth Token: Name: `CLAUDE_CODE_OAUTH_TOKEN`, Value: Your Claude Code OAuth token (Pro and Max users can generate this by running `claude setup-token` locally)
|
||||||
|
5. Click "Add secret"
|
||||||
|
|
||||||
|
### Best Practices for Authentication
|
||||||
|
|
||||||
|
1. ✅ Always use `${{ secrets.ANTHROPIC_API_KEY }}` or `${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}` in workflows
|
||||||
|
2. ✅ Never commit API keys or tokens to version control
|
||||||
|
3. ✅ Regularly rotate your API keys and tokens
|
||||||
|
4. ✅ Use environment secrets for organization-wide access
|
||||||
|
5. ❌ Never share API keys or tokens in pull requests or issues
|
||||||
|
6. ❌ Avoid logging workflow variables that might contain keys
|
||||||
129
docs/usage.md
Normal file
129
docs/usage.md
Normal file
@@ -0,0 +1,129 @@
|
|||||||
|
# Usage
|
||||||
|
|
||||||
|
Add a workflow file to your repository (e.g., `.github/workflows/claude.yml`):
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
name: Claude Assistant
|
||||||
|
on:
|
||||||
|
issue_comment:
|
||||||
|
types: [created]
|
||||||
|
pull_request_review_comment:
|
||||||
|
types: [created]
|
||||||
|
issues:
|
||||||
|
types: [opened, assigned, labeled]
|
||||||
|
pull_request_review:
|
||||||
|
types: [submitted]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
claude-response:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: anthropics/claude-code-action@beta
|
||||||
|
with:
|
||||||
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
|
# Or use OAuth token instead:
|
||||||
|
# claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
|
||||||
|
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
# Optional: set execution mode (default: tag)
|
||||||
|
# mode: "tag"
|
||||||
|
# Optional: add custom trigger phrase (default: @claude)
|
||||||
|
# trigger_phrase: "/claude"
|
||||||
|
# Optional: add assignee trigger for issues
|
||||||
|
# assignee_trigger: "claude"
|
||||||
|
# Optional: add label trigger for issues
|
||||||
|
# label_trigger: "claude"
|
||||||
|
# Optional: add custom environment variables (YAML format)
|
||||||
|
# claude_env: |
|
||||||
|
# NODE_ENV: test
|
||||||
|
# DEBUG: true
|
||||||
|
# API_URL: https://api.example.com
|
||||||
|
# Optional: limit the number of conversation turns
|
||||||
|
# max_turns: "5"
|
||||||
|
# Optional: grant additional permissions (requires corresponding GitHub token permissions)
|
||||||
|
# additional_permissions: |
|
||||||
|
# actions: read
|
||||||
|
# Optional: allow bot users to trigger the action
|
||||||
|
# allowed_bots: "dependabot[bot],renovate[bot]"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Inputs
|
||||||
|
|
||||||
|
| Input | Description | Required | Default |
|
||||||
|
| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- | -------- | --------- |
|
||||||
|
| `mode` | Execution mode: 'tag' (default - triggered by mentions/assignments), 'agent' (for automation), 'experimental-review' (for PR reviews) | No | `tag` |
|
||||||
|
| `anthropic_api_key` | Anthropic API key (required for direct API, not needed for Bedrock/Vertex) | No\* | - |
|
||||||
|
| `claude_code_oauth_token` | Claude Code OAuth token (alternative to anthropic_api_key) | No\* | - |
|
||||||
|
| `direct_prompt` | Direct prompt for Claude to execute automatically without needing a trigger (for automated workflows) | No | - |
|
||||||
|
| `override_prompt` | Complete replacement of Claude's prompt with custom template (supports variable substitution) | No | - |
|
||||||
|
| `base_branch` | The base branch to use for creating new branches (e.g., 'main', 'develop') | No | - |
|
||||||
|
| `max_turns` | Maximum number of conversation turns Claude can take (limits back-and-forth exchanges) | No | - |
|
||||||
|
| `timeout_minutes` | Timeout in minutes for execution | No | `30` |
|
||||||
|
| `use_sticky_comment` | Use just one comment to deliver PR comments (only applies for pull_request event workflows) | No | `false` |
|
||||||
|
| `github_token` | GitHub token for Claude to operate with. **Only include this if you're connecting a custom GitHub app of your own!** | No | - |
|
||||||
|
| `model` | Model to use (provider-specific format required for Bedrock/Vertex) | No | - |
|
||||||
|
| `fallback_model` | Enable automatic fallback to specified model when primary model is unavailable | No | - |
|
||||||
|
| `anthropic_model` | **DEPRECATED**: Use `model` instead. Kept for backward compatibility. | No | - |
|
||||||
|
| `use_bedrock` | Use Amazon Bedrock with OIDC authentication instead of direct Anthropic API | No | `false` |
|
||||||
|
| `use_vertex` | Use Google Vertex AI with OIDC authentication instead of direct Anthropic API | No | `false` |
|
||||||
|
| `allowed_tools` | Additional tools for Claude to use (the base GitHub tools will always be included) | No | "" |
|
||||||
|
| `disallowed_tools` | Tools that Claude should never use | No | "" |
|
||||||
|
| `custom_instructions` | Additional custom instructions to include in the prompt for Claude | No | "" |
|
||||||
|
| `mcp_config` | Additional MCP configuration (JSON string) that merges with the built-in GitHub MCP servers | No | "" |
|
||||||
|
| `assignee_trigger` | The assignee username that triggers the action (e.g. @claude). Only used for issue assignment | No | - |
|
||||||
|
| `label_trigger` | The label name that triggers the action when applied to an issue (e.g. "claude") | No | - |
|
||||||
|
| `trigger_phrase` | The trigger phrase to look for in comments, issue/PR bodies, and issue titles | No | `@claude` |
|
||||||
|
| `branch_prefix` | The prefix to use for Claude branches (defaults to 'claude/', use 'claude-' for dash format) | No | `claude/` |
|
||||||
|
| `claude_env` | Custom environment variables to pass to Claude Code execution (YAML format) | No | "" |
|
||||||
|
| `settings` | Claude Code settings as JSON string or path to settings JSON file | No | "" |
|
||||||
|
| `additional_permissions` | Additional permissions to enable. Currently supports 'actions: read' for viewing workflow results | No | "" |
|
||||||
|
| `experimental_allowed_domains` | Restrict network access to these domains only (newline-separated). | No | "" |
|
||||||
|
| `use_commit_signing` | Enable commit signing using GitHub's commit signature verification. When false, Claude uses standard git commands | No | `false` |
|
||||||
|
| `allowed_bots` | Comma-separated list of allowed bot usernames, or '\*' to allow all bots. Empty string (default) allows no bots | No | "" |
|
||||||
|
|
||||||
|
\*Required when using direct Anthropic API (default and when not using Bedrock or Vertex)
|
||||||
|
|
||||||
|
> **Note**: This action is currently in beta. Features and APIs may change as we continue to improve the integration.
|
||||||
|
|
||||||
|
## Ways to Tag @claude
|
||||||
|
|
||||||
|
These examples show how to interact with Claude using comments in PRs and issues. By default, Claude will be triggered anytime you mention `@claude`, but you can customize the exact trigger phrase using the `trigger_phrase` input in the workflow.
|
||||||
|
|
||||||
|
Claude will see the full PR context, including any comments.
|
||||||
|
|
||||||
|
### Ask Questions
|
||||||
|
|
||||||
|
Add a comment to a PR or issue:
|
||||||
|
|
||||||
|
```
|
||||||
|
@claude What does this function do and how could we improve it?
|
||||||
|
```
|
||||||
|
|
||||||
|
Claude will analyze the code and provide a detailed explanation with suggestions.
|
||||||
|
|
||||||
|
### Request Fixes
|
||||||
|
|
||||||
|
Ask Claude to implement specific changes:
|
||||||
|
|
||||||
|
```
|
||||||
|
@claude Can you add error handling to this function?
|
||||||
|
```
|
||||||
|
|
||||||
|
### Code Review
|
||||||
|
|
||||||
|
Get a thorough review:
|
||||||
|
|
||||||
|
```
|
||||||
|
@claude Please review this PR and suggest improvements
|
||||||
|
```
|
||||||
|
|
||||||
|
Claude will analyze the changes and provide feedback.
|
||||||
|
|
||||||
|
### Fix Bugs from Screenshots
|
||||||
|
|
||||||
|
Upload a screenshot of a bug and ask Claude to fix it:
|
||||||
|
|
||||||
|
```
|
||||||
|
@claude Here's a screenshot of a bug I'm seeing [upload screenshot]. Can you fix it?
|
||||||
|
```
|
||||||
|
|
||||||
|
Claude can see and analyze images, making it easy to fix visual bugs or UI issues.
|
||||||
45
examples/claude-experimental-review-mode.yml
Normal file
45
examples/claude-experimental-review-mode.yml
Normal file
@@ -0,0 +1,45 @@
|
|||||||
|
name: Claude Experimental Review Mode
|
||||||
|
|
||||||
|
on:
|
||||||
|
pull_request:
|
||||||
|
types: [opened, synchronize]
|
||||||
|
issue_comment:
|
||||||
|
types: [created]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
code-review:
|
||||||
|
# Run on PR events, or when someone comments "@claude review" on a PR
|
||||||
|
if: |
|
||||||
|
github.event_name == 'pull_request' ||
|
||||||
|
(github.event_name == 'issue_comment' &&
|
||||||
|
github.event.issue.pull_request &&
|
||||||
|
contains(github.event.comment.body, '@claude review'))
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
pull-requests: write
|
||||||
|
issues: write
|
||||||
|
id-token: write
|
||||||
|
steps:
|
||||||
|
- name: Checkout repository
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
fetch-depth: 0 # Full history for better diff analysis
|
||||||
|
|
||||||
|
- name: Code Review with Claude
|
||||||
|
uses: anthropics/claude-code-action@beta
|
||||||
|
with:
|
||||||
|
mode: experimental-review
|
||||||
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
|
# github_token not needed - uses default GITHUB_TOKEN for GitHub operations
|
||||||
|
timeout_minutes: "30"
|
||||||
|
custom_instructions: |
|
||||||
|
Focus on:
|
||||||
|
- Code quality and maintainability
|
||||||
|
- Security vulnerabilities
|
||||||
|
- Performance issues
|
||||||
|
- Best practices and design patterns
|
||||||
|
- Test coverage gaps
|
||||||
|
|
||||||
|
Be constructive and provide specific suggestions for improvements.
|
||||||
|
Use GitHub's suggestion format when proposing code changes.
|
||||||
@@ -1,13 +1,17 @@
|
|||||||
name: Claude Mode Examples
|
name: Claude Mode Examples
|
||||||
|
|
||||||
on:
|
on:
|
||||||
# Common events for both modes
|
# Events for tag mode
|
||||||
issue_comment:
|
issue_comment:
|
||||||
types: [created]
|
types: [created]
|
||||||
issues:
|
issues:
|
||||||
types: [opened, labeled]
|
types: [opened, labeled]
|
||||||
pull_request:
|
pull_request:
|
||||||
types: [opened]
|
types: [opened]
|
||||||
|
# Events for agent mode (only these work with agent mode)
|
||||||
|
workflow_dispatch:
|
||||||
|
schedule:
|
||||||
|
- cron: "0 0 * * 0" # Weekly on Sunday
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
# Tag Mode (Default) - Traditional implementation
|
# Tag Mode (Default) - Traditional implementation
|
||||||
@@ -28,13 +32,12 @@ jobs:
|
|||||||
# - Creates tracking comments with progress checkboxes
|
# - Creates tracking comments with progress checkboxes
|
||||||
# - Perfect for: Interactive Q&A, on-demand code changes
|
# - Perfect for: Interactive Q&A, on-demand code changes
|
||||||
|
|
||||||
# Agent Mode - Automation without triggers
|
# Agent Mode - Automation for workflow_dispatch and schedule events
|
||||||
agent-mode-auto-review:
|
agent-mode-scheduled-task:
|
||||||
# Automatically review every new PR
|
# Only works with workflow_dispatch or schedule events
|
||||||
if: github.event_name == 'pull_request' && github.event.action == 'opened'
|
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
permissions:
|
permissions:
|
||||||
contents: read
|
contents: write
|
||||||
pull-requests: write
|
pull-requests: write
|
||||||
issues: write
|
issues: write
|
||||||
id-token: write
|
id-token: write
|
||||||
@@ -44,13 +47,10 @@ jobs:
|
|||||||
mode: agent
|
mode: agent
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
override_prompt: |
|
override_prompt: |
|
||||||
Review this PR for code quality. Focus on:
|
Check for outdated dependencies and security vulnerabilities.
|
||||||
- Potential bugs or logic errors
|
Create an issue if any critical problems are found.
|
||||||
- Security concerns
|
|
||||||
- Performance issues
|
|
||||||
|
|
||||||
Provide specific, actionable feedback.
|
|
||||||
# Agent mode behavior:
|
# Agent mode behavior:
|
||||||
# - NO @claude mention needed - runs immediately
|
# - ONLY works with workflow_dispatch and schedule events
|
||||||
# - Enables true automation (impossible with tag mode)
|
# - Does NOT work with pull_request, issues, or issue_comment events
|
||||||
# - Perfect for: CI/CD integration, automatic reviews, label-based workflows
|
# - No @claude mention needed for supported events
|
||||||
|
# - Perfect for: scheduled maintenance, manual automation runs
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
name: Claude PR Assistant
|
name: Claude Code
|
||||||
|
|
||||||
on:
|
on:
|
||||||
issue_comment:
|
issue_comment:
|
||||||
@@ -11,38 +11,53 @@ on:
|
|||||||
types: [submitted]
|
types: [submitted]
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
claude-code-action:
|
claude:
|
||||||
if: |
|
if: |
|
||||||
(github.event_name == 'issue_comment' && contains(github.event.comment.body, '@claude')) ||
|
(github.event_name == 'issue_comment' && contains(github.event.comment.body, '@claude')) ||
|
||||||
(github.event_name == 'pull_request_review_comment' && contains(github.event.comment.body, '@claude')) ||
|
(github.event_name == 'pull_request_review_comment' && contains(github.event.comment.body, '@claude')) ||
|
||||||
(github.event_name == 'pull_request_review' && contains(github.event.review.body, '@claude')) ||
|
(github.event_name == 'pull_request_review' && contains(github.event.review.body, '@claude')) ||
|
||||||
(github.event_name == 'issues' && contains(github.event.issue.body, '@claude'))
|
(github.event_name == 'issues' && (contains(github.event.issue.body, '@claude') || contains(github.event.issue.title, '@claude')))
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
permissions:
|
permissions:
|
||||||
contents: read
|
contents: write
|
||||||
pull-requests: read
|
pull-requests: write
|
||||||
issues: read
|
issues: write
|
||||||
id-token: write
|
id-token: write
|
||||||
|
actions: read # Required for Claude to read CI results on PRs
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout repository
|
- name: Checkout repository
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
fetch-depth: 1
|
fetch-depth: 1
|
||||||
|
|
||||||
- name: Run Claude PR Action
|
- name: Run Claude Code
|
||||||
|
id: claude
|
||||||
uses: anthropics/claude-code-action@beta
|
uses: anthropics/claude-code-action@beta
|
||||||
with:
|
with:
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
anthropic_api_key: \${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
# Or use OAuth token instead:
|
|
||||||
# claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
|
# This is an optional setting that allows Claude to read CI results on PRs
|
||||||
timeout_minutes: "60"
|
additional_permissions: |
|
||||||
# mode: tag # Default: responds to @claude mentions
|
actions: read
|
||||||
# Optional: Restrict network access to specific domains only
|
|
||||||
# experimental_allowed_domains: |
|
# Optional: Specify model (defaults to Claude Sonnet 4, uncomment for Claude Opus 4.1)
|
||||||
# .anthropic.com
|
# model: "claude-opus-4-1-20250805"
|
||||||
# .github.com
|
|
||||||
# api.github.com
|
# Optional: Customize the trigger phrase (default: @claude)
|
||||||
# .githubusercontent.com
|
# trigger_phrase: "/claude"
|
||||||
# bun.sh
|
|
||||||
# registry.npmjs.org
|
# Optional: Trigger when specific user is assigned to an issue
|
||||||
# .blob.core.windows.net
|
# assignee_trigger: "claude-bot"
|
||||||
|
|
||||||
|
# Optional: Allow Claude to run specific commands
|
||||||
|
# allowed_tools: "Bash(npm install),Bash(npm run build),Bash(npm run test:*),Bash(npm run lint:*)"
|
||||||
|
|
||||||
|
# Optional: Add custom instructions for Claude to customize its behavior for your project
|
||||||
|
# custom_instructions: |
|
||||||
|
# Follow our coding standards
|
||||||
|
# Ensure all new code has tests
|
||||||
|
# Use TypeScript for new files
|
||||||
|
|
||||||
|
# Optional: Custom environment variables for Claude
|
||||||
|
# claude_env: |
|
||||||
|
# NODE_ENV: test
|
||||||
|
|||||||
@@ -6,8 +6,8 @@ echo "Installing git hooks..."
|
|||||||
# Make sure hooks directory exists
|
# Make sure hooks directory exists
|
||||||
mkdir -p .git/hooks
|
mkdir -p .git/hooks
|
||||||
|
|
||||||
# Install pre-push hook
|
# Install pre-commit hook
|
||||||
cp scripts/pre-push .git/hooks/pre-push
|
cp scripts/pre-commit .git/hooks/pre-commit
|
||||||
chmod +x .git/hooks/pre-push
|
chmod +x .git/hooks/pre-commit
|
||||||
|
|
||||||
echo "Git hooks installed successfully!"
|
echo "Git hooks installed successfully!"
|
||||||
@@ -60,8 +60,6 @@ export function buildAllowedToolsString(
|
|||||||
"Bash(git diff:*)",
|
"Bash(git diff:*)",
|
||||||
"Bash(git log:*)",
|
"Bash(git log:*)",
|
||||||
"Bash(git rm:*)",
|
"Bash(git rm:*)",
|
||||||
"Bash(git config user.name:*)",
|
|
||||||
"Bash(git config user.email:*)",
|
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -530,6 +528,7 @@ export function generatePrompt(
|
|||||||
context: PreparedContext,
|
context: PreparedContext,
|
||||||
githubData: FetchDataResult,
|
githubData: FetchDataResult,
|
||||||
useCommitSigning: boolean,
|
useCommitSigning: boolean,
|
||||||
|
mode: Mode,
|
||||||
): string {
|
): string {
|
||||||
if (context.overridePrompt) {
|
if (context.overridePrompt) {
|
||||||
return substitutePromptVariables(
|
return substitutePromptVariables(
|
||||||
@@ -539,6 +538,19 @@ export function generatePrompt(
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Use the mode's prompt generator
|
||||||
|
return mode.generatePrompt(context, githubData, useCommitSigning);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Generates the default prompt for tag mode
|
||||||
|
* @internal
|
||||||
|
*/
|
||||||
|
export function generateDefaultPrompt(
|
||||||
|
context: PreparedContext,
|
||||||
|
githubData: FetchDataResult,
|
||||||
|
useCommitSigning: boolean = false,
|
||||||
|
): string {
|
||||||
const {
|
const {
|
||||||
contextData,
|
contextData,
|
||||||
comments,
|
comments,
|
||||||
@@ -810,7 +822,9 @@ export async function createPrompt(
|
|||||||
let claudeCommentId: string = "";
|
let claudeCommentId: string = "";
|
||||||
if (mode.name === "tag") {
|
if (mode.name === "tag") {
|
||||||
if (!modeContext.commentId) {
|
if (!modeContext.commentId) {
|
||||||
throw new Error("Tag mode requires a comment ID for prompt generation");
|
throw new Error(
|
||||||
|
`${mode.name} mode requires a comment ID for prompt generation`,
|
||||||
|
);
|
||||||
}
|
}
|
||||||
claudeCommentId = modeContext.commentId.toString();
|
claudeCommentId = modeContext.commentId.toString();
|
||||||
}
|
}
|
||||||
@@ -831,6 +845,7 @@ export async function createPrompt(
|
|||||||
preparedContext,
|
preparedContext,
|
||||||
githubData,
|
githubData,
|
||||||
context.inputs.useCommitSigning,
|
context.inputs.useCommitSigning,
|
||||||
|
mode,
|
||||||
);
|
);
|
||||||
|
|
||||||
// Log the final prompt to console
|
// Log the final prompt to console
|
||||||
|
|||||||
@@ -372,8 +372,12 @@ export function formatGroupedContent(groupedContent: GroupedContent[]): string {
|
|||||||
const usage = item.usage || {};
|
const usage = item.usage || {};
|
||||||
if (Object.keys(usage).length > 0) {
|
if (Object.keys(usage).length > 0) {
|
||||||
const inputTokens = usage.input_tokens || 0;
|
const inputTokens = usage.input_tokens || 0;
|
||||||
|
const cacheCreationTokens = usage.cache_creation_input_tokens || 0;
|
||||||
|
const cacheReadTokens = usage.cache_read_input_tokens || 0;
|
||||||
|
const totalInputTokens =
|
||||||
|
inputTokens + cacheCreationTokens + cacheReadTokens;
|
||||||
const outputTokens = usage.output_tokens || 0;
|
const outputTokens = usage.output_tokens || 0;
|
||||||
markdown += `*Token usage: ${inputTokens} input, ${outputTokens} output*\n\n`;
|
markdown += `*Token usage: ${totalInputTokens} input, ${outputTokens} output*\n\n`;
|
||||||
}
|
}
|
||||||
|
|
||||||
// Only add separator if this section had content
|
// Only add separator if this section had content
|
||||||
|
|||||||
@@ -10,13 +10,37 @@ import { setupGitHubToken } from "../github/token";
|
|||||||
import { checkWritePermissions } from "../github/validation/permissions";
|
import { checkWritePermissions } from "../github/validation/permissions";
|
||||||
import { createOctokit } from "../github/api/client";
|
import { createOctokit } from "../github/api/client";
|
||||||
import { parseGitHubContext, isEntityContext } from "../github/context";
|
import { parseGitHubContext, isEntityContext } from "../github/context";
|
||||||
import { getMode } from "../modes/registry";
|
import { getMode, isValidMode, DEFAULT_MODE } from "../modes/registry";
|
||||||
|
import type { ModeName } from "../modes/types";
|
||||||
import { prepare } from "../prepare";
|
import { prepare } from "../prepare";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
try {
|
try {
|
||||||
// Step 1: Setup GitHub token
|
// Step 1: Get mode first to determine authentication method
|
||||||
const githubToken = await setupGitHubToken();
|
const modeInput = process.env.MODE || DEFAULT_MODE;
|
||||||
|
|
||||||
|
// Validate mode input
|
||||||
|
if (!isValidMode(modeInput)) {
|
||||||
|
throw new Error(`Invalid mode: ${modeInput}`);
|
||||||
|
}
|
||||||
|
const validatedMode: ModeName = modeInput;
|
||||||
|
|
||||||
|
// Step 2: Setup GitHub token based on mode
|
||||||
|
let githubToken: string;
|
||||||
|
if (validatedMode === "experimental-review") {
|
||||||
|
// For experimental-review mode, use the default GitHub Action token
|
||||||
|
githubToken = process.env.DEFAULT_WORKFLOW_TOKEN || "";
|
||||||
|
if (!githubToken) {
|
||||||
|
throw new Error(
|
||||||
|
"DEFAULT_WORKFLOW_TOKEN not found for experimental-review mode",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
console.log("Using default GitHub Action token for review mode");
|
||||||
|
core.setOutput("GITHUB_TOKEN", githubToken);
|
||||||
|
} else {
|
||||||
|
// For other modes, use the existing token exchange
|
||||||
|
githubToken = await setupGitHubToken();
|
||||||
|
}
|
||||||
const octokit = createOctokit(githubToken);
|
const octokit = createOctokit(githubToken);
|
||||||
|
|
||||||
// Step 2: Parse GitHub context (once for all operations)
|
// Step 2: Parse GitHub context (once for all operations)
|
||||||
@@ -36,7 +60,7 @@ async function run() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Step 4: Get mode and check trigger conditions
|
// Step 4: Get mode and check trigger conditions
|
||||||
const mode = getMode(context.inputs.mode, context);
|
const mode = getMode(validatedMode, context);
|
||||||
const containsTrigger = mode.shouldTrigger(context);
|
const containsTrigger = mode.shouldTrigger(context);
|
||||||
|
|
||||||
// Set output for action.yml to check
|
// Set output for action.yml to check
|
||||||
@@ -57,6 +81,19 @@ async function run() {
|
|||||||
|
|
||||||
// Set the MCP config output
|
// Set the MCP config output
|
||||||
core.setOutput("mcp_config", result.mcpConfig);
|
core.setOutput("mcp_config", result.mcpConfig);
|
||||||
|
|
||||||
|
// Step 6: Get system prompt from mode if available
|
||||||
|
if (mode.getSystemPrompt) {
|
||||||
|
const modeContext = mode.prepareContext(context, {
|
||||||
|
commentId: result.commentId,
|
||||||
|
baseBranch: result.branchInfo.baseBranch,
|
||||||
|
claudeBranch: result.branchInfo.claudeBranch,
|
||||||
|
});
|
||||||
|
const systemPrompt = mode.getSystemPrompt(modeContext);
|
||||||
|
if (systemPrompt) {
|
||||||
|
core.exportVariable("APPEND_SYSTEM_PROMPT", systemPrompt);
|
||||||
|
}
|
||||||
|
}
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
const errorMessage = error instanceof Error ? error.message : String(error);
|
const errorMessage = error instanceof Error ? error.message : String(error);
|
||||||
core.setFailed(`Prepare step failed with error: ${errorMessage}`);
|
core.setFailed(`Prepare step failed with error: ${errorMessage}`);
|
||||||
|
|||||||
@@ -77,6 +77,7 @@ type BaseContext = {
|
|||||||
useStickyComment: boolean;
|
useStickyComment: boolean;
|
||||||
additionalPermissions: Map<string, string>;
|
additionalPermissions: Map<string, string>;
|
||||||
useCommitSigning: boolean;
|
useCommitSigning: boolean;
|
||||||
|
allowedBots: string;
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -136,6 +137,7 @@ export function parseGitHubContext(): GitHubContext {
|
|||||||
process.env.ADDITIONAL_PERMISSIONS ?? "",
|
process.env.ADDITIONAL_PERMISSIONS ?? "",
|
||||||
),
|
),
|
||||||
useCommitSigning: process.env.USE_COMMIT_SIGNING === "true",
|
useCommitSigning: process.env.USE_COMMIT_SIGNING === "true",
|
||||||
|
allowedBots: process.env.ALLOWED_BOTS ?? "",
|
||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|||||||
@@ -78,7 +78,7 @@ export async function setupGitHubToken(): Promise<string> {
|
|||||||
return appToken;
|
return appToken;
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
core.setFailed(
|
core.setFailed(
|
||||||
`Failed to setup GitHub token: ${error}.\n\nIf you instead wish to use this action with a custom GitHub token or custom GitHub app, provide a \`github_token\` in the \`uses\` section of the app in your workflow yml file.`,
|
`Failed to setup GitHub token: ${error}\n\nIf you instead wish to use this action with a custom GitHub token or custom GitHub app, provide a \`github_token\` in the \`uses\` section of the app in your workflow yml file.`,
|
||||||
);
|
);
|
||||||
process.exit(1);
|
process.exit(1);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,11 +3,17 @@ import path from "path";
|
|||||||
import type { Octokits } from "../api/client";
|
import type { Octokits } from "../api/client";
|
||||||
import { GITHUB_SERVER_URL } from "../api/config";
|
import { GITHUB_SERVER_URL } from "../api/config";
|
||||||
|
|
||||||
|
const escapedUrl = GITHUB_SERVER_URL.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
|
||||||
const IMAGE_REGEX = new RegExp(
|
const IMAGE_REGEX = new RegExp(
|
||||||
`!\\[[^\\]]*\\]\\((${GITHUB_SERVER_URL.replace(/[.*+?^${}()|[\]\\]/g, "\\$&")}\\/user-attachments\\/assets\\/[^)]+)\\)`,
|
`!\\[[^\\]]*\\]\\((${escapedUrl}\\/user-attachments\\/assets\\/[^)]+)\\)`,
|
||||||
"g",
|
"g",
|
||||||
);
|
);
|
||||||
|
|
||||||
|
const HTML_IMG_REGEX = new RegExp(
|
||||||
|
`<img[^>]+src=["']([^"']*${escapedUrl}\\/user-attachments\\/assets\\/[^"']+)["'][^>]*>`,
|
||||||
|
"gi",
|
||||||
|
);
|
||||||
|
|
||||||
type IssueComment = {
|
type IssueComment = {
|
||||||
type: "issue_comment";
|
type: "issue_comment";
|
||||||
id: string;
|
id: string;
|
||||||
@@ -63,8 +69,16 @@ export async function downloadCommentImages(
|
|||||||
}> = [];
|
}> = [];
|
||||||
|
|
||||||
for (const comment of comments) {
|
for (const comment of comments) {
|
||||||
const imageMatches = [...comment.body.matchAll(IMAGE_REGEX)];
|
// Extract URLs from Markdown format
|
||||||
const urls = imageMatches.map((match) => match[1] as string);
|
const markdownMatches = [...comment.body.matchAll(IMAGE_REGEX)];
|
||||||
|
const markdownUrls = markdownMatches.map((match) => match[1] as string);
|
||||||
|
|
||||||
|
// Extract URLs from HTML format
|
||||||
|
const htmlMatches = [...comment.body.matchAll(HTML_IMG_REGEX)];
|
||||||
|
const htmlUrls = htmlMatches.map((match) => match[1] as string);
|
||||||
|
|
||||||
|
// Combine and deduplicate URLs
|
||||||
|
const urls = [...new Set([...markdownUrls, ...htmlUrls])];
|
||||||
|
|
||||||
if (urls.length > 0) {
|
if (urls.length > 0) {
|
||||||
commentsWithImages.push({ comment, urls });
|
commentsWithImages.push({ comment, urls });
|
||||||
|
|||||||
@@ -58,6 +58,41 @@ export function sanitizeContent(content: string): string {
|
|||||||
content = stripMarkdownLinkTitles(content);
|
content = stripMarkdownLinkTitles(content);
|
||||||
content = stripHiddenAttributes(content);
|
content = stripHiddenAttributes(content);
|
||||||
content = normalizeHtmlEntities(content);
|
content = normalizeHtmlEntities(content);
|
||||||
|
content = redactGitHubTokens(content);
|
||||||
|
return content;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function redactGitHubTokens(content: string): string {
|
||||||
|
// GitHub Personal Access Tokens (classic): ghp_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX (40 chars)
|
||||||
|
content = content.replace(
|
||||||
|
/\bghp_[A-Za-z0-9]{36}\b/g,
|
||||||
|
"[REDACTED_GITHUB_TOKEN]",
|
||||||
|
);
|
||||||
|
|
||||||
|
// GitHub OAuth tokens: gho_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX (40 chars)
|
||||||
|
content = content.replace(
|
||||||
|
/\bgho_[A-Za-z0-9]{36}\b/g,
|
||||||
|
"[REDACTED_GITHUB_TOKEN]",
|
||||||
|
);
|
||||||
|
|
||||||
|
// GitHub installation tokens: ghs_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX (40 chars)
|
||||||
|
content = content.replace(
|
||||||
|
/\bghs_[A-Za-z0-9]{36}\b/g,
|
||||||
|
"[REDACTED_GITHUB_TOKEN]",
|
||||||
|
);
|
||||||
|
|
||||||
|
// GitHub refresh tokens: ghr_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX (40 chars)
|
||||||
|
content = content.replace(
|
||||||
|
/\bghr_[A-Za-z0-9]{36}\b/g,
|
||||||
|
"[REDACTED_GITHUB_TOKEN]",
|
||||||
|
);
|
||||||
|
|
||||||
|
// GitHub fine-grained personal access tokens: github_pat_XXXXXXXXXX (up to 255 chars)
|
||||||
|
content = content.replace(
|
||||||
|
/\bgithub_pat_[A-Za-z0-9_]{11,221}\b/g,
|
||||||
|
"[REDACTED_GITHUB_TOKEN]",
|
||||||
|
);
|
||||||
|
|
||||||
return content;
|
return content;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -21,9 +21,42 @@ export async function checkHumanActor(
|
|||||||
|
|
||||||
console.log(`Actor type: ${actorType}`);
|
console.log(`Actor type: ${actorType}`);
|
||||||
|
|
||||||
|
// Check bot permissions if actor is not a User
|
||||||
if (actorType !== "User") {
|
if (actorType !== "User") {
|
||||||
|
const allowedBots = githubContext.inputs.allowedBots;
|
||||||
|
|
||||||
|
// Check if all bots are allowed
|
||||||
|
if (allowedBots.trim() === "*") {
|
||||||
|
console.log(
|
||||||
|
`All bots are allowed, skipping human actor check for: ${githubContext.actor}`,
|
||||||
|
);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Parse allowed bots list
|
||||||
|
const allowedBotsList = allowedBots
|
||||||
|
.split(",")
|
||||||
|
.map((bot) =>
|
||||||
|
bot
|
||||||
|
.trim()
|
||||||
|
.toLowerCase()
|
||||||
|
.replace(/\[bot\]$/, ""),
|
||||||
|
)
|
||||||
|
.filter((bot) => bot.length > 0);
|
||||||
|
|
||||||
|
const botName = githubContext.actor.toLowerCase().replace(/\[bot\]$/, "");
|
||||||
|
|
||||||
|
// Check if specific bot is allowed
|
||||||
|
if (allowedBotsList.includes(botName)) {
|
||||||
|
console.log(
|
||||||
|
`Bot ${botName} is in allowed list, skipping human actor check`,
|
||||||
|
);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Bot not allowed
|
||||||
throw new Error(
|
throw new Error(
|
||||||
`Workflow initiated by non-human actor: ${githubContext.actor} (type: ${actorType}).`,
|
`Workflow initiated by non-human actor: ${botName} (type: ${actorType}). Add bot to allowed_bots list or use '*' to allow all bots.`,
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -17,6 +17,12 @@ export async function checkWritePermissions(
|
|||||||
try {
|
try {
|
||||||
core.info(`Checking permissions for actor: ${actor}`);
|
core.info(`Checking permissions for actor: ${actor}`);
|
||||||
|
|
||||||
|
// Check if the actor is a GitHub App (bot user)
|
||||||
|
if (actor.endsWith("[bot]")) {
|
||||||
|
core.info(`Actor is a GitHub App: ${actor}`);
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
// Check permissions directly using the permission endpoint
|
// Check permissions directly using the permission endpoint
|
||||||
const response = await octokit.repos.getCollaboratorPermissionLevel({
|
const response = await octokit.repos.getCollaboratorPermissionLevel({
|
||||||
owner: repository.owner,
|
owner: repository.owner,
|
||||||
|
|||||||
@@ -6,6 +6,7 @@ import { z } from "zod";
|
|||||||
import { GITHUB_API_URL } from "../github/api/config";
|
import { GITHUB_API_URL } from "../github/api/config";
|
||||||
import { Octokit } from "@octokit/rest";
|
import { Octokit } from "@octokit/rest";
|
||||||
import { updateClaudeComment } from "../github/operations/comments/update-claude-comment";
|
import { updateClaudeComment } from "../github/operations/comments/update-claude-comment";
|
||||||
|
import { sanitizeContent } from "../github/utils/sanitizer";
|
||||||
|
|
||||||
// Get repository information from environment variables
|
// Get repository information from environment variables
|
||||||
const REPO_OWNER = process.env.REPO_OWNER;
|
const REPO_OWNER = process.env.REPO_OWNER;
|
||||||
@@ -54,11 +55,13 @@ server.tool(
|
|||||||
const isPullRequestReviewComment =
|
const isPullRequestReviewComment =
|
||||||
eventName === "pull_request_review_comment";
|
eventName === "pull_request_review_comment";
|
||||||
|
|
||||||
|
const sanitizedBody = sanitizeContent(body);
|
||||||
|
|
||||||
const result = await updateClaudeComment(octokit, {
|
const result = await updateClaudeComment(octokit, {
|
||||||
owner,
|
owner,
|
||||||
repo,
|
repo,
|
||||||
commentId,
|
commentId,
|
||||||
body,
|
body: sanitizedBody,
|
||||||
isPullRequestReviewComment,
|
isPullRequestReviewComment,
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|||||||
184
src/mcp/github-inline-comment-server.ts
Normal file
184
src/mcp/github-inline-comment-server.ts
Normal file
@@ -0,0 +1,184 @@
|
|||||||
|
#!/usr/bin/env node
|
||||||
|
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
||||||
|
import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
|
||||||
|
import { z } from "zod";
|
||||||
|
import { createOctokit } from "../github/api/client";
|
||||||
|
import { sanitizeContent } from "../github/utils/sanitizer";
|
||||||
|
|
||||||
|
// Get repository and PR information from environment variables
|
||||||
|
const REPO_OWNER = process.env.REPO_OWNER;
|
||||||
|
const REPO_NAME = process.env.REPO_NAME;
|
||||||
|
const PR_NUMBER = process.env.PR_NUMBER;
|
||||||
|
|
||||||
|
if (!REPO_OWNER || !REPO_NAME || !PR_NUMBER) {
|
||||||
|
console.error(
|
||||||
|
"Error: REPO_OWNER, REPO_NAME, and PR_NUMBER environment variables are required",
|
||||||
|
);
|
||||||
|
process.exit(1);
|
||||||
|
}
|
||||||
|
|
||||||
|
// GitHub Inline Comment MCP Server - Provides inline PR comment functionality
|
||||||
|
// Provides an inline comment tool without exposing full PR review capabilities, so that
|
||||||
|
// Claude can't accidentally approve a PR
|
||||||
|
const server = new McpServer({
|
||||||
|
name: "GitHub Inline Comment Server",
|
||||||
|
version: "0.0.1",
|
||||||
|
});
|
||||||
|
|
||||||
|
server.tool(
|
||||||
|
"create_inline_comment",
|
||||||
|
"Create an inline comment on a specific line or lines in a PR file",
|
||||||
|
{
|
||||||
|
path: z
|
||||||
|
.string()
|
||||||
|
.describe("The file path to comment on (e.g., 'src/index.js')"),
|
||||||
|
body: z
|
||||||
|
.string()
|
||||||
|
.describe(
|
||||||
|
"The comment text (supports markdown and GitHub code suggestion blocks). " +
|
||||||
|
"For code suggestions, use: ```suggestion\\nreplacement code\\n```. " +
|
||||||
|
"IMPORTANT: The suggestion block will REPLACE the ENTIRE line range (single line or startLine to line). " +
|
||||||
|
"Ensure the replacement is syntactically complete and valid - it must work as a drop-in replacement for the selected lines.",
|
||||||
|
),
|
||||||
|
line: z
|
||||||
|
.number()
|
||||||
|
.nonnegative()
|
||||||
|
.optional()
|
||||||
|
.describe(
|
||||||
|
"Line number for single-line comments (required if startLine is not provided)",
|
||||||
|
),
|
||||||
|
startLine: z
|
||||||
|
.number()
|
||||||
|
.nonnegative()
|
||||||
|
.optional()
|
||||||
|
.describe(
|
||||||
|
"Start line for multi-line comments (use with line parameter for the end line)",
|
||||||
|
),
|
||||||
|
side: z
|
||||||
|
.enum(["LEFT", "RIGHT"])
|
||||||
|
.optional()
|
||||||
|
.default("RIGHT")
|
||||||
|
.describe(
|
||||||
|
"Side of the diff to comment on: LEFT (old code) or RIGHT (new code)",
|
||||||
|
),
|
||||||
|
commit_id: z
|
||||||
|
.string()
|
||||||
|
.optional()
|
||||||
|
.describe(
|
||||||
|
"Specific commit SHA to comment on (defaults to latest commit)",
|
||||||
|
),
|
||||||
|
},
|
||||||
|
async ({ path, body, line, startLine, side, commit_id }) => {
|
||||||
|
try {
|
||||||
|
const githubToken = process.env.GITHUB_TOKEN;
|
||||||
|
|
||||||
|
if (!githubToken) {
|
||||||
|
throw new Error("GITHUB_TOKEN environment variable is required");
|
||||||
|
}
|
||||||
|
|
||||||
|
const owner = REPO_OWNER;
|
||||||
|
const repo = REPO_NAME;
|
||||||
|
const pull_number = parseInt(PR_NUMBER, 10);
|
||||||
|
|
||||||
|
const octokit = createOctokit(githubToken).rest;
|
||||||
|
|
||||||
|
// Sanitize the comment body to remove any potential GitHub tokens
|
||||||
|
const sanitizedBody = sanitizeContent(body);
|
||||||
|
|
||||||
|
// Validate that either line or both startLine and line are provided
|
||||||
|
if (!line && !startLine) {
|
||||||
|
throw new Error(
|
||||||
|
"Either 'line' for single-line comments or both 'startLine' and 'line' for multi-line comments must be provided",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// If only line is provided, it's a single-line comment
|
||||||
|
// If both startLine and line are provided, it's a multi-line comment
|
||||||
|
const isSingleLine = !startLine;
|
||||||
|
|
||||||
|
const pr = await octokit.pulls.get({
|
||||||
|
owner,
|
||||||
|
repo,
|
||||||
|
pull_number,
|
||||||
|
});
|
||||||
|
|
||||||
|
const params: Parameters<
|
||||||
|
typeof octokit.rest.pulls.createReviewComment
|
||||||
|
>[0] = {
|
||||||
|
owner,
|
||||||
|
repo,
|
||||||
|
pull_number,
|
||||||
|
body: sanitizedBody,
|
||||||
|
path,
|
||||||
|
side: side || "RIGHT",
|
||||||
|
commit_id: commit_id || pr.data.head.sha,
|
||||||
|
};
|
||||||
|
|
||||||
|
if (isSingleLine) {
|
||||||
|
// Single-line comment
|
||||||
|
params.line = line;
|
||||||
|
} else {
|
||||||
|
// Multi-line comment
|
||||||
|
params.start_line = startLine;
|
||||||
|
params.start_side = side || "RIGHT";
|
||||||
|
params.line = line;
|
||||||
|
}
|
||||||
|
|
||||||
|
const result = await octokit.rest.pulls.createReviewComment(params);
|
||||||
|
|
||||||
|
return {
|
||||||
|
content: [
|
||||||
|
{
|
||||||
|
type: "text",
|
||||||
|
text: JSON.stringify(
|
||||||
|
{
|
||||||
|
success: true,
|
||||||
|
comment_id: result.data.id,
|
||||||
|
html_url: result.data.html_url,
|
||||||
|
path: result.data.path,
|
||||||
|
line: result.data.line || result.data.original_line,
|
||||||
|
message: `Inline comment created successfully on ${path}${isSingleLine ? ` at line ${line}` : ` from line ${startLine} to ${line}`}`,
|
||||||
|
},
|
||||||
|
null,
|
||||||
|
2,
|
||||||
|
),
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
|
} catch (error) {
|
||||||
|
const errorMessage =
|
||||||
|
error instanceof Error ? error.message : String(error);
|
||||||
|
|
||||||
|
// Provide more helpful error messages for common issues
|
||||||
|
let helpMessage = "";
|
||||||
|
if (errorMessage.includes("Validation Failed")) {
|
||||||
|
helpMessage =
|
||||||
|
"\n\nThis usually means the line number doesn't exist in the diff or the file path is incorrect. Make sure you're commenting on lines that are part of the PR's changes.";
|
||||||
|
} else if (errorMessage.includes("Not Found")) {
|
||||||
|
helpMessage =
|
||||||
|
"\n\nThis usually means the PR number, repository, or file path is incorrect.";
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
content: [
|
||||||
|
{
|
||||||
|
type: "text",
|
||||||
|
text: `Error creating inline comment: ${errorMessage}${helpMessage}`,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
error: errorMessage,
|
||||||
|
isError: true,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
async function runServer() {
|
||||||
|
const transport = new StdioServerTransport();
|
||||||
|
await server.connect(transport);
|
||||||
|
process.on("exit", () => {
|
||||||
|
server.close();
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
runServer().catch(console.error);
|
||||||
@@ -111,6 +111,24 @@ export async function prepareMcpConfig(
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Include inline comment server for experimental review mode
|
||||||
|
if (context.inputs.mode === "experimental-review" && context.isPR) {
|
||||||
|
baseMcpConfig.mcpServers.github_inline_comment = {
|
||||||
|
command: "bun",
|
||||||
|
args: [
|
||||||
|
"run",
|
||||||
|
`${process.env.GITHUB_ACTION_PATH}/src/mcp/github-inline-comment-server.ts`,
|
||||||
|
],
|
||||||
|
env: {
|
||||||
|
GITHUB_TOKEN: githubToken,
|
||||||
|
REPO_OWNER: owner,
|
||||||
|
REPO_NAME: repo,
|
||||||
|
PR_NUMBER: context.entityNumber?.toString() || "",
|
||||||
|
GITHUB_API_URL: GITHUB_API_URL,
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
// Only add CI server if we have actions:read permission and we're in a PR context
|
// Only add CI server if we have actions:read permission and we're in a PR context
|
||||||
const hasActionsReadPermission =
|
const hasActionsReadPermission =
|
||||||
context.inputs.additionalPermissions.get("actions") === "read";
|
context.inputs.additionalPermissions.get("actions") === "read";
|
||||||
@@ -118,7 +136,7 @@ export async function prepareMcpConfig(
|
|||||||
if (context.isPR && hasActionsReadPermission) {
|
if (context.isPR && hasActionsReadPermission) {
|
||||||
// Verify the token actually has actions:read permission
|
// Verify the token actually has actions:read permission
|
||||||
const actuallyHasPermission = await checkActionsReadPermission(
|
const actuallyHasPermission = await checkActionsReadPermission(
|
||||||
process.env.ACTIONS_TOKEN || "",
|
process.env.DEFAULT_WORKFLOW_TOKEN || "",
|
||||||
owner,
|
owner,
|
||||||
repo,
|
repo,
|
||||||
);
|
);
|
||||||
@@ -138,7 +156,7 @@ export async function prepareMcpConfig(
|
|||||||
],
|
],
|
||||||
env: {
|
env: {
|
||||||
// Use workflow github token, not app token
|
// Use workflow github token, not app token
|
||||||
GITHUB_TOKEN: process.env.ACTIONS_TOKEN,
|
GITHUB_TOKEN: process.env.DEFAULT_WORKFLOW_TOKEN,
|
||||||
REPO_OWNER: owner,
|
REPO_OWNER: owner,
|
||||||
REPO_NAME: repo,
|
REPO_NAME: repo,
|
||||||
PR_NUMBER: context.entityNumber?.toString() || "",
|
PR_NUMBER: context.entityNumber?.toString() || "",
|
||||||
|
|||||||
@@ -2,6 +2,7 @@ import * as core from "@actions/core";
|
|||||||
import { mkdir, writeFile } from "fs/promises";
|
import { mkdir, writeFile } from "fs/promises";
|
||||||
import type { Mode, ModeOptions, ModeResult } from "../types";
|
import type { Mode, ModeOptions, ModeResult } from "../types";
|
||||||
import { isAutomationContext } from "../../github/context";
|
import { isAutomationContext } from "../../github/context";
|
||||||
|
import type { PreparedContext } from "../../create-prompt/types";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Agent mode implementation.
|
* Agent mode implementation.
|
||||||
@@ -42,11 +43,11 @@ export const agentMode: Mode = {
|
|||||||
async prepare({ context }: ModeOptions): Promise<ModeResult> {
|
async prepare({ context }: ModeOptions): Promise<ModeResult> {
|
||||||
// Agent mode handles automation events (workflow_dispatch, schedule) only
|
// Agent mode handles automation events (workflow_dispatch, schedule) only
|
||||||
|
|
||||||
|
// TODO: handle by createPrompt (similar to tag and review modes)
|
||||||
// Create prompt directory
|
// Create prompt directory
|
||||||
await mkdir(`${process.env.RUNNER_TEMP}/claude-prompts`, {
|
await mkdir(`${process.env.RUNNER_TEMP}/claude-prompts`, {
|
||||||
recursive: true,
|
recursive: true,
|
||||||
});
|
});
|
||||||
|
|
||||||
// Write the prompt file - the base action requires a prompt_file parameter,
|
// Write the prompt file - the base action requires a prompt_file parameter,
|
||||||
// so we must create this file even though agent mode typically uses
|
// so we must create this file even though agent mode typically uses
|
||||||
// override_prompt or direct_prompt. If neither is provided, we write
|
// override_prompt or direct_prompt. If neither is provided, we write
|
||||||
@@ -55,7 +56,6 @@ export const agentMode: Mode = {
|
|||||||
context.inputs.overridePrompt ||
|
context.inputs.overridePrompt ||
|
||||||
context.inputs.directPrompt ||
|
context.inputs.directPrompt ||
|
||||||
`Repository: ${context.repository.owner}/${context.repository.repo}`;
|
`Repository: ${context.repository.owner}/${context.repository.repo}`;
|
||||||
|
|
||||||
await writeFile(
|
await writeFile(
|
||||||
`${process.env.RUNNER_TEMP}/claude-prompts/claude-prompt.txt`,
|
`${process.env.RUNNER_TEMP}/claude-prompts/claude-prompt.txt`,
|
||||||
promptContent,
|
promptContent,
|
||||||
@@ -114,4 +114,23 @@ export const agentMode: Mode = {
|
|||||||
mcpConfig: JSON.stringify(mcpConfig),
|
mcpConfig: JSON.stringify(mcpConfig),
|
||||||
};
|
};
|
||||||
},
|
},
|
||||||
|
|
||||||
|
generatePrompt(context: PreparedContext): string {
|
||||||
|
// Agent mode uses override or direct prompt, no GitHub data needed
|
||||||
|
if (context.overridePrompt) {
|
||||||
|
return context.overridePrompt;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (context.directPrompt) {
|
||||||
|
return context.directPrompt;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Minimal fallback - repository is a string in PreparedContext
|
||||||
|
return `Repository: ${context.repository}`;
|
||||||
|
},
|
||||||
|
|
||||||
|
getSystemPrompt() {
|
||||||
|
// Agent mode doesn't need additional system prompts
|
||||||
|
return undefined;
|
||||||
|
},
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -13,11 +13,12 @@
|
|||||||
import type { Mode, ModeName } from "./types";
|
import type { Mode, ModeName } from "./types";
|
||||||
import { tagMode } from "./tag";
|
import { tagMode } from "./tag";
|
||||||
import { agentMode } from "./agent";
|
import { agentMode } from "./agent";
|
||||||
|
import { reviewMode } from "./review";
|
||||||
import type { GitHubContext } from "../github/context";
|
import type { GitHubContext } from "../github/context";
|
||||||
import { isAutomationContext } from "../github/context";
|
import { isAutomationContext } from "../github/context";
|
||||||
|
|
||||||
export const DEFAULT_MODE = "tag" as const;
|
export const DEFAULT_MODE = "tag" as const;
|
||||||
export const VALID_MODES = ["tag", "agent"] as const;
|
export const VALID_MODES = ["tag", "agent", "experimental-review"] as const;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* All available modes.
|
* All available modes.
|
||||||
@@ -26,6 +27,7 @@ export const VALID_MODES = ["tag", "agent"] as const;
|
|||||||
const modes = {
|
const modes = {
|
||||||
tag: tagMode,
|
tag: tagMode,
|
||||||
agent: agentMode,
|
agent: agentMode,
|
||||||
|
"experimental-review": reviewMode,
|
||||||
} as const satisfies Record<ModeName, Mode>;
|
} as const satisfies Record<ModeName, Mode>;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
328
src/modes/review/index.ts
Normal file
328
src/modes/review/index.ts
Normal file
@@ -0,0 +1,328 @@
|
|||||||
|
import * as core from "@actions/core";
|
||||||
|
import type { Mode, ModeOptions, ModeResult } from "../types";
|
||||||
|
import { checkContainsTrigger } from "../../github/validation/trigger";
|
||||||
|
import { prepareMcpConfig } from "../../mcp/install-mcp-server";
|
||||||
|
import { fetchGitHubData } from "../../github/data/fetcher";
|
||||||
|
import type { FetchDataResult } from "../../github/data/fetcher";
|
||||||
|
import { createPrompt } from "../../create-prompt";
|
||||||
|
import type { PreparedContext } from "../../create-prompt";
|
||||||
|
import { isEntityContext, isPullRequestEvent } from "../../github/context";
|
||||||
|
import {
|
||||||
|
formatContext,
|
||||||
|
formatBody,
|
||||||
|
formatComments,
|
||||||
|
formatReviewComments,
|
||||||
|
formatChangedFilesWithSHA,
|
||||||
|
} from "../../github/data/formatter";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Review mode implementation.
|
||||||
|
*
|
||||||
|
* Code review mode that uses the default GitHub Action token
|
||||||
|
* and focuses on providing inline comments and suggestions.
|
||||||
|
* Automatically includes GitHub MCP tools for review operations.
|
||||||
|
*/
|
||||||
|
export const reviewMode: Mode = {
|
||||||
|
name: "experimental-review",
|
||||||
|
description:
|
||||||
|
"Experimental code review mode for inline comments and suggestions",
|
||||||
|
|
||||||
|
shouldTrigger(context) {
|
||||||
|
if (!isEntityContext(context)) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Review mode only works on PRs
|
||||||
|
if (!context.isPR) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
// For pull_request events, only trigger on specific actions
|
||||||
|
if (isPullRequestEvent(context)) {
|
||||||
|
const allowedActions = ["opened", "synchronize", "reopened"];
|
||||||
|
const action = context.payload.action;
|
||||||
|
return allowedActions.includes(action);
|
||||||
|
}
|
||||||
|
|
||||||
|
// For other events (comments), check for trigger phrase
|
||||||
|
return checkContainsTrigger(context);
|
||||||
|
},
|
||||||
|
|
||||||
|
prepareContext(context, data) {
|
||||||
|
return {
|
||||||
|
mode: "experimental-review",
|
||||||
|
githubContext: context,
|
||||||
|
commentId: data?.commentId,
|
||||||
|
baseBranch: data?.baseBranch,
|
||||||
|
claudeBranch: data?.claudeBranch,
|
||||||
|
};
|
||||||
|
},
|
||||||
|
|
||||||
|
getAllowedTools() {
|
||||||
|
return [
|
||||||
|
"Bash(gh issue comment:*)",
|
||||||
|
"mcp__github_inline_comment__create_inline_comment",
|
||||||
|
];
|
||||||
|
},
|
||||||
|
|
||||||
|
getDisallowedTools() {
|
||||||
|
return [];
|
||||||
|
},
|
||||||
|
|
||||||
|
shouldCreateTrackingComment() {
|
||||||
|
return false; // Review mode uses the review body instead of a tracking comment
|
||||||
|
},
|
||||||
|
|
||||||
|
generatePrompt(
|
||||||
|
context: PreparedContext,
|
||||||
|
githubData: FetchDataResult,
|
||||||
|
): string {
|
||||||
|
// Support overridePrompt
|
||||||
|
if (context.overridePrompt) {
|
||||||
|
return context.overridePrompt;
|
||||||
|
}
|
||||||
|
|
||||||
|
const {
|
||||||
|
contextData,
|
||||||
|
comments,
|
||||||
|
changedFilesWithSHA,
|
||||||
|
reviewData,
|
||||||
|
imageUrlMap,
|
||||||
|
} = githubData;
|
||||||
|
const { eventData } = context;
|
||||||
|
|
||||||
|
const formattedContext = formatContext(contextData, true); // Reviews are always for PRs
|
||||||
|
const formattedComments = formatComments(comments, imageUrlMap);
|
||||||
|
const formattedReviewComments = formatReviewComments(
|
||||||
|
reviewData,
|
||||||
|
imageUrlMap,
|
||||||
|
);
|
||||||
|
const formattedChangedFiles =
|
||||||
|
formatChangedFilesWithSHA(changedFilesWithSHA);
|
||||||
|
const formattedBody = contextData?.body
|
||||||
|
? formatBody(contextData.body, imageUrlMap)
|
||||||
|
: "No description provided";
|
||||||
|
|
||||||
|
// Using a variable for code blocks to avoid escaping backticks in the template string
|
||||||
|
const codeBlock = "```";
|
||||||
|
|
||||||
|
return `You are Claude, an AI assistant specialized in code reviews for GitHub pull requests. You are operating in REVIEW MODE, which means you should focus on providing thorough code review feedback using GitHub MCP tools for inline comments and suggestions.
|
||||||
|
|
||||||
|
<formatted_context>
|
||||||
|
${formattedContext}
|
||||||
|
</formatted_context>
|
||||||
|
|
||||||
|
<repository>${context.repository}</repository>
|
||||||
|
${eventData.isPR && eventData.prNumber ? `<pr_number>${eventData.prNumber}</pr_number>` : ""}
|
||||||
|
|
||||||
|
<comments>
|
||||||
|
${formattedComments || "No comments yet"}
|
||||||
|
</comments>
|
||||||
|
|
||||||
|
<review_comments>
|
||||||
|
${formattedReviewComments || "No review comments"}
|
||||||
|
</review_comments>
|
||||||
|
|
||||||
|
<changed_files>
|
||||||
|
${formattedChangedFiles}
|
||||||
|
</changed_files>
|
||||||
|
|
||||||
|
<formatted_body>
|
||||||
|
${formattedBody}
|
||||||
|
</formatted_body>
|
||||||
|
|
||||||
|
${
|
||||||
|
(eventData.eventName === "issue_comment" ||
|
||||||
|
eventData.eventName === "pull_request_review_comment" ||
|
||||||
|
eventData.eventName === "pull_request_review") &&
|
||||||
|
eventData.commentBody
|
||||||
|
? `<trigger_comment>
|
||||||
|
User @${context.triggerUsername}: ${eventData.commentBody}
|
||||||
|
</trigger_comment>`
|
||||||
|
: ""
|
||||||
|
}
|
||||||
|
|
||||||
|
${
|
||||||
|
context.directPrompt
|
||||||
|
? `<direct_prompt>
|
||||||
|
${context.directPrompt}
|
||||||
|
</direct_prompt>`
|
||||||
|
: ""
|
||||||
|
}
|
||||||
|
|
||||||
|
REVIEW MODE WORKFLOW:
|
||||||
|
|
||||||
|
1. First, understand the PR context:
|
||||||
|
- You are reviewing PR #${eventData.isPR && eventData.prNumber ? eventData.prNumber : "[PR number]"} in ${context.repository}
|
||||||
|
- Use the Read, Grep, and Glob tools to examine the modified files directly from disk
|
||||||
|
- This provides the full context and latest state of the code
|
||||||
|
- Look at the changed_files section above to see which files were modified
|
||||||
|
|
||||||
|
2. Create review comments using GitHub MCP tools:
|
||||||
|
- Use Bash(gh issue comment:*) for general PR-level comments
|
||||||
|
- Use mcp__github_inline_comment__create_inline_comment for line-specific feedback (strongly preferred)
|
||||||
|
|
||||||
|
3. When creating inline comments with suggestions:
|
||||||
|
CRITICAL: GitHub's suggestion blocks REPLACE the ENTIRE line range you select
|
||||||
|
- For single-line comments: Use 'line' parameter only
|
||||||
|
- For multi-line comments: Use both 'startLine' and 'line' parameters
|
||||||
|
- The 'body' parameter should contain your comment and/or suggestion block
|
||||||
|
|
||||||
|
How to write code suggestions correctly:
|
||||||
|
a) To remove a line (e.g., removing console.log on line 22):
|
||||||
|
- Set line: 22
|
||||||
|
- Body: ${codeBlock}suggestion
|
||||||
|
${codeBlock}
|
||||||
|
(Empty suggestion block removes the line)
|
||||||
|
|
||||||
|
b) To modify a single line (e.g., fixing line 22):
|
||||||
|
- Set line: 22
|
||||||
|
- Body: ${codeBlock}suggestion
|
||||||
|
await this.emailInput.fill(email);
|
||||||
|
${codeBlock}
|
||||||
|
|
||||||
|
c) To replace multiple lines (e.g., lines 21-23):
|
||||||
|
- Set startLine: 21, line: 23
|
||||||
|
- Body must include ALL lines being replaced:
|
||||||
|
${codeBlock}suggestion
|
||||||
|
async typeEmail(email: string): Promise<void> {
|
||||||
|
await this.emailInput.fill(email);
|
||||||
|
}
|
||||||
|
${codeBlock}
|
||||||
|
|
||||||
|
COMMON MISTAKE TO AVOID:
|
||||||
|
Never duplicate code in suggestions. For example, DON'T do this:
|
||||||
|
${codeBlock}suggestion
|
||||||
|
async typeEmail(email: string): Promise<void> {
|
||||||
|
async typeEmail(email: string): Promise<void> { // WRONG: Duplicate signature!
|
||||||
|
await this.emailInput.fill(email);
|
||||||
|
}
|
||||||
|
${codeBlock}
|
||||||
|
|
||||||
|
REVIEW GUIDELINES:
|
||||||
|
|
||||||
|
- Focus on:
|
||||||
|
* Security vulnerabilities
|
||||||
|
* Bugs and logic errors
|
||||||
|
* Performance issues
|
||||||
|
* Code quality and maintainability
|
||||||
|
* Best practices and standards
|
||||||
|
* Edge cases and error handling
|
||||||
|
|
||||||
|
- Provide:
|
||||||
|
* Specific, actionable feedback
|
||||||
|
* Code suggestions using the exact format described above
|
||||||
|
* Clear explanations of issues found
|
||||||
|
* Constructive criticism with solutions
|
||||||
|
* Recognition of good practices
|
||||||
|
* For complex changes: Create separate inline comments for each logical change
|
||||||
|
|
||||||
|
- Communication:
|
||||||
|
* All feedback goes through GitHub's review system
|
||||||
|
* Be professional and respectful
|
||||||
|
* Your review body is the main communication channel
|
||||||
|
|
||||||
|
Before starting, analyze the PR inside <analysis> tags:
|
||||||
|
<analysis>
|
||||||
|
- PR title and description
|
||||||
|
- Number of files changed and scope
|
||||||
|
- Type of changes (feature, bug fix, refactor, etc.)
|
||||||
|
- Key areas to focus on
|
||||||
|
- Review strategy
|
||||||
|
</analysis>
|
||||||
|
|
||||||
|
Then proceed with the review workflow described above.
|
||||||
|
|
||||||
|
IMPORTANT: Your review body is the primary way users will understand your feedback. Make it comprehensive and well-structured with:
|
||||||
|
- Executive summary at the top
|
||||||
|
- Detailed findings organized by severity or category
|
||||||
|
- Clear action items and recommendations
|
||||||
|
- Recognition of good practices
|
||||||
|
This ensures users get value from the review even before checking individual inline comments.`;
|
||||||
|
},
|
||||||
|
|
||||||
|
async prepare({
|
||||||
|
context,
|
||||||
|
octokit,
|
||||||
|
githubToken,
|
||||||
|
}: ModeOptions): Promise<ModeResult> {
|
||||||
|
if (!isEntityContext(context)) {
|
||||||
|
throw new Error("Review mode requires entity context");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Review mode doesn't create a tracking comment
|
||||||
|
const githubData = await fetchGitHubData({
|
||||||
|
octokits: octokit,
|
||||||
|
repository: `${context.repository.owner}/${context.repository.repo}`,
|
||||||
|
prNumber: context.entityNumber.toString(),
|
||||||
|
isPR: context.isPR,
|
||||||
|
triggerUsername: context.actor,
|
||||||
|
});
|
||||||
|
|
||||||
|
// Review mode doesn't need branch setup or git auth since it only creates comments
|
||||||
|
// Using minimal branch info since review mode doesn't create or modify branches
|
||||||
|
const branchInfo = {
|
||||||
|
baseBranch: "main",
|
||||||
|
currentBranch: "",
|
||||||
|
claudeBranch: undefined, // Review mode doesn't create branches
|
||||||
|
};
|
||||||
|
|
||||||
|
const modeContext = this.prepareContext(context, {
|
||||||
|
baseBranch: branchInfo.baseBranch,
|
||||||
|
claudeBranch: branchInfo.claudeBranch,
|
||||||
|
});
|
||||||
|
|
||||||
|
await createPrompt(reviewMode, modeContext, githubData, context);
|
||||||
|
|
||||||
|
// Export tool environment variables for review mode
|
||||||
|
const baseTools = [
|
||||||
|
"Edit",
|
||||||
|
"MultiEdit",
|
||||||
|
"Glob",
|
||||||
|
"Grep",
|
||||||
|
"LS",
|
||||||
|
"Read",
|
||||||
|
"Write",
|
||||||
|
];
|
||||||
|
|
||||||
|
// Add mode-specific and user-specified tools
|
||||||
|
const allowedTools = [
|
||||||
|
...baseTools,
|
||||||
|
...this.getAllowedTools(),
|
||||||
|
...context.inputs.allowedTools,
|
||||||
|
];
|
||||||
|
const disallowedTools = [
|
||||||
|
"WebSearch",
|
||||||
|
"WebFetch",
|
||||||
|
...context.inputs.disallowedTools,
|
||||||
|
];
|
||||||
|
|
||||||
|
core.exportVariable("ALLOWED_TOOLS", allowedTools.join(","));
|
||||||
|
core.exportVariable("DISALLOWED_TOOLS", disallowedTools.join(","));
|
||||||
|
|
||||||
|
const additionalMcpConfig = process.env.MCP_CONFIG || "";
|
||||||
|
const mcpConfig = await prepareMcpConfig({
|
||||||
|
githubToken,
|
||||||
|
owner: context.repository.owner,
|
||||||
|
repo: context.repository.repo,
|
||||||
|
branch: branchInfo.claudeBranch || branchInfo.currentBranch,
|
||||||
|
baseBranch: branchInfo.baseBranch,
|
||||||
|
additionalMcpConfig,
|
||||||
|
allowedTools: [...this.getAllowedTools(), ...context.inputs.allowedTools],
|
||||||
|
context,
|
||||||
|
});
|
||||||
|
|
||||||
|
core.setOutput("mcp_config", mcpConfig);
|
||||||
|
|
||||||
|
return {
|
||||||
|
branchInfo,
|
||||||
|
mcpConfig,
|
||||||
|
};
|
||||||
|
},
|
||||||
|
|
||||||
|
getSystemPrompt() {
|
||||||
|
// Review mode doesn't need additional system prompts
|
||||||
|
// The review-specific instructions are included in the main prompt
|
||||||
|
return undefined;
|
||||||
|
},
|
||||||
|
};
|
||||||
@@ -7,8 +7,10 @@ import { setupBranch } from "../../github/operations/branch";
|
|||||||
import { configureGitAuth } from "../../github/operations/git-config";
|
import { configureGitAuth } from "../../github/operations/git-config";
|
||||||
import { prepareMcpConfig } from "../../mcp/install-mcp-server";
|
import { prepareMcpConfig } from "../../mcp/install-mcp-server";
|
||||||
import { fetchGitHubData } from "../../github/data/fetcher";
|
import { fetchGitHubData } from "../../github/data/fetcher";
|
||||||
import { createPrompt } from "../../create-prompt";
|
import { createPrompt, generateDefaultPrompt } from "../../create-prompt";
|
||||||
import { isEntityContext } from "../../github/context";
|
import { isEntityContext } from "../../github/context";
|
||||||
|
import type { PreparedContext } from "../../create-prompt/types";
|
||||||
|
import type { FetchDataResult } from "../../github/data/fetcher";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Tag mode implementation.
|
* Tag mode implementation.
|
||||||
@@ -120,4 +122,17 @@ export const tagMode: Mode = {
|
|||||||
mcpConfig,
|
mcpConfig,
|
||||||
};
|
};
|
||||||
},
|
},
|
||||||
|
|
||||||
|
generatePrompt(
|
||||||
|
context: PreparedContext,
|
||||||
|
githubData: FetchDataResult,
|
||||||
|
useCommitSigning: boolean,
|
||||||
|
): string {
|
||||||
|
return generateDefaultPrompt(context, githubData, useCommitSigning);
|
||||||
|
},
|
||||||
|
|
||||||
|
getSystemPrompt() {
|
||||||
|
// Tag mode doesn't need additional system prompts
|
||||||
|
return undefined;
|
||||||
|
},
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -1,6 +1,9 @@
|
|||||||
import type { GitHubContext } from "../github/context";
|
import type { GitHubContext } from "../github/context";
|
||||||
|
import type { PreparedContext } from "../create-prompt/types";
|
||||||
|
import type { FetchDataResult } from "../github/data/fetcher";
|
||||||
|
import type { Octokits } from "../github/api/client";
|
||||||
|
|
||||||
export type ModeName = "tag" | "agent";
|
export type ModeName = "tag" | "agent" | "experimental-review";
|
||||||
|
|
||||||
export type ModeContext = {
|
export type ModeContext = {
|
||||||
mode: ModeName;
|
mode: ModeName;
|
||||||
@@ -54,18 +57,35 @@ export type Mode = {
|
|||||||
*/
|
*/
|
||||||
shouldCreateTrackingComment(): boolean;
|
shouldCreateTrackingComment(): boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Generates the prompt for this mode.
|
||||||
|
* @returns The complete prompt string
|
||||||
|
*/
|
||||||
|
generatePrompt(
|
||||||
|
context: PreparedContext,
|
||||||
|
githubData: FetchDataResult,
|
||||||
|
useCommitSigning: boolean,
|
||||||
|
): string;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Prepares the GitHub environment for this mode.
|
* Prepares the GitHub environment for this mode.
|
||||||
* Each mode decides how to handle different event types.
|
* Each mode decides how to handle different event types.
|
||||||
* @returns PrepareResult with commentId, branchInfo, and mcpConfig
|
* @returns PrepareResult with commentId, branchInfo, and mcpConfig
|
||||||
*/
|
*/
|
||||||
prepare(options: ModeOptions): Promise<ModeResult>;
|
prepare(options: ModeOptions): Promise<ModeResult>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns an optional system prompt to append to Claude's base system prompt.
|
||||||
|
* This allows modes to add mode-specific instructions.
|
||||||
|
* @returns The system prompt string or undefined if no additional prompt is needed
|
||||||
|
*/
|
||||||
|
getSystemPrompt?(context: ModeContext): string | undefined;
|
||||||
};
|
};
|
||||||
|
|
||||||
// Define types for mode prepare method to avoid circular dependencies
|
// Define types for mode prepare method
|
||||||
export type ModeOptions = {
|
export type ModeOptions = {
|
||||||
context: GitHubContext;
|
context: GitHubContext;
|
||||||
octokit: any; // We'll use any to avoid circular dependency with Octokits
|
octokit: Octokits;
|
||||||
githubToken: string;
|
githubToken: string;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|||||||
96
test/actor.test.ts
Normal file
96
test/actor.test.ts
Normal file
@@ -0,0 +1,96 @@
|
|||||||
|
#!/usr/bin/env bun
|
||||||
|
|
||||||
|
import { describe, test, expect } from "bun:test";
|
||||||
|
import { checkHumanActor } from "../src/github/validation/actor";
|
||||||
|
import type { Octokit } from "@octokit/rest";
|
||||||
|
import { createMockContext } from "./mockContext";
|
||||||
|
|
||||||
|
function createMockOctokit(userType: string): Octokit {
|
||||||
|
return {
|
||||||
|
users: {
|
||||||
|
getByUsername: async () => ({
|
||||||
|
data: {
|
||||||
|
type: userType,
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
},
|
||||||
|
} as unknown as Octokit;
|
||||||
|
}
|
||||||
|
|
||||||
|
describe("checkHumanActor", () => {
|
||||||
|
test("should pass for human actor", async () => {
|
||||||
|
const mockOctokit = createMockOctokit("User");
|
||||||
|
const context = createMockContext();
|
||||||
|
context.actor = "human-user";
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
checkHumanActor(mockOctokit, context),
|
||||||
|
).resolves.toBeUndefined();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should throw error for bot actor when not allowed", async () => {
|
||||||
|
const mockOctokit = createMockOctokit("Bot");
|
||||||
|
const context = createMockContext();
|
||||||
|
context.actor = "test-bot[bot]";
|
||||||
|
context.inputs.allowedBots = "";
|
||||||
|
|
||||||
|
await expect(checkHumanActor(mockOctokit, context)).rejects.toThrow(
|
||||||
|
"Workflow initiated by non-human actor: test-bot (type: Bot). Add bot to allowed_bots list or use '*' to allow all bots.",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should pass for bot actor when all bots allowed", async () => {
|
||||||
|
const mockOctokit = createMockOctokit("Bot");
|
||||||
|
const context = createMockContext();
|
||||||
|
context.actor = "test-bot[bot]";
|
||||||
|
context.inputs.allowedBots = "*";
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
checkHumanActor(mockOctokit, context),
|
||||||
|
).resolves.toBeUndefined();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should pass for specific bot when in allowed list", async () => {
|
||||||
|
const mockOctokit = createMockOctokit("Bot");
|
||||||
|
const context = createMockContext();
|
||||||
|
context.actor = "dependabot[bot]";
|
||||||
|
context.inputs.allowedBots = "dependabot[bot],renovate[bot]";
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
checkHumanActor(mockOctokit, context),
|
||||||
|
).resolves.toBeUndefined();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should pass for specific bot when in allowed list (without [bot])", async () => {
|
||||||
|
const mockOctokit = createMockOctokit("Bot");
|
||||||
|
const context = createMockContext();
|
||||||
|
context.actor = "dependabot[bot]";
|
||||||
|
context.inputs.allowedBots = "dependabot,renovate";
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
checkHumanActor(mockOctokit, context),
|
||||||
|
).resolves.toBeUndefined();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should throw error for bot not in allowed list", async () => {
|
||||||
|
const mockOctokit = createMockOctokit("Bot");
|
||||||
|
const context = createMockContext();
|
||||||
|
context.actor = "other-bot[bot]";
|
||||||
|
context.inputs.allowedBots = "dependabot[bot],renovate[bot]";
|
||||||
|
|
||||||
|
await expect(checkHumanActor(mockOctokit, context)).rejects.toThrow(
|
||||||
|
"Workflow initiated by non-human actor: other-bot (type: Bot). Add bot to allowed_bots list or use '*' to allow all bots.",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should throw error for bot not in allowed list (without [bot])", async () => {
|
||||||
|
const mockOctokit = createMockOctokit("Bot");
|
||||||
|
const context = createMockContext();
|
||||||
|
context.actor = "other-bot[bot]";
|
||||||
|
context.inputs.allowedBots = "dependabot,renovate";
|
||||||
|
|
||||||
|
await expect(checkHumanActor(mockOctokit, context)).rejects.toThrow(
|
||||||
|
"Workflow initiated by non-human actor: other-bot (type: Bot). Add bot to allowed_bots list or use '*' to allow all bots.",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -3,13 +3,37 @@
|
|||||||
import { describe, test, expect } from "bun:test";
|
import { describe, test, expect } from "bun:test";
|
||||||
import {
|
import {
|
||||||
generatePrompt,
|
generatePrompt,
|
||||||
|
generateDefaultPrompt,
|
||||||
getEventTypeAndContext,
|
getEventTypeAndContext,
|
||||||
buildAllowedToolsString,
|
buildAllowedToolsString,
|
||||||
buildDisallowedToolsString,
|
buildDisallowedToolsString,
|
||||||
} from "../src/create-prompt";
|
} from "../src/create-prompt";
|
||||||
import type { PreparedContext } from "../src/create-prompt";
|
import type { PreparedContext } from "../src/create-prompt";
|
||||||
|
import type { Mode } from "../src/modes/types";
|
||||||
|
|
||||||
describe("generatePrompt", () => {
|
describe("generatePrompt", () => {
|
||||||
|
// Create a mock tag mode that uses the default prompt
|
||||||
|
const mockTagMode: Mode = {
|
||||||
|
name: "tag",
|
||||||
|
description: "Tag mode",
|
||||||
|
shouldTrigger: () => true,
|
||||||
|
prepareContext: (context) => ({ mode: "tag", githubContext: context }),
|
||||||
|
getAllowedTools: () => [],
|
||||||
|
getDisallowedTools: () => [],
|
||||||
|
shouldCreateTrackingComment: () => true,
|
||||||
|
generatePrompt: (context, githubData, useCommitSigning) =>
|
||||||
|
generateDefaultPrompt(context, githubData, useCommitSigning),
|
||||||
|
prepare: async () => ({
|
||||||
|
commentId: 123,
|
||||||
|
branchInfo: {
|
||||||
|
baseBranch: "main",
|
||||||
|
currentBranch: "main",
|
||||||
|
claudeBranch: undefined,
|
||||||
|
},
|
||||||
|
mcpConfig: "{}",
|
||||||
|
}),
|
||||||
|
};
|
||||||
|
|
||||||
const mockGitHubData = {
|
const mockGitHubData = {
|
||||||
contextData: {
|
contextData: {
|
||||||
title: "Test PR",
|
title: "Test PR",
|
||||||
@@ -133,7 +157,7 @@ describe("generatePrompt", () => {
|
|||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
const prompt = generatePrompt(envVars, mockGitHubData, false);
|
const prompt = generatePrompt(envVars, mockGitHubData, false, mockTagMode);
|
||||||
|
|
||||||
expect(prompt).toContain("You are Claude, an AI assistant");
|
expect(prompt).toContain("You are Claude, an AI assistant");
|
||||||
expect(prompt).toContain("<event_type>GENERAL_COMMENT</event_type>");
|
expect(prompt).toContain("<event_type>GENERAL_COMMENT</event_type>");
|
||||||
@@ -161,7 +185,7 @@ describe("generatePrompt", () => {
|
|||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
const prompt = generatePrompt(envVars, mockGitHubData, false);
|
const prompt = generatePrompt(envVars, mockGitHubData, false, mockTagMode);
|
||||||
|
|
||||||
expect(prompt).toContain("<event_type>PR_REVIEW</event_type>");
|
expect(prompt).toContain("<event_type>PR_REVIEW</event_type>");
|
||||||
expect(prompt).toContain("<is_pr>true</is_pr>");
|
expect(prompt).toContain("<is_pr>true</is_pr>");
|
||||||
@@ -187,7 +211,7 @@ describe("generatePrompt", () => {
|
|||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
const prompt = generatePrompt(envVars, mockGitHubData, false);
|
const prompt = generatePrompt(envVars, mockGitHubData, false, mockTagMode);
|
||||||
|
|
||||||
expect(prompt).toContain("<event_type>ISSUE_CREATED</event_type>");
|
expect(prompt).toContain("<event_type>ISSUE_CREATED</event_type>");
|
||||||
expect(prompt).toContain(
|
expect(prompt).toContain(
|
||||||
@@ -215,7 +239,7 @@ describe("generatePrompt", () => {
|
|||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
const prompt = generatePrompt(envVars, mockGitHubData, false);
|
const prompt = generatePrompt(envVars, mockGitHubData, false, mockTagMode);
|
||||||
|
|
||||||
expect(prompt).toContain("<event_type>ISSUE_ASSIGNED</event_type>");
|
expect(prompt).toContain("<event_type>ISSUE_ASSIGNED</event_type>");
|
||||||
expect(prompt).toContain(
|
expect(prompt).toContain(
|
||||||
@@ -242,7 +266,7 @@ describe("generatePrompt", () => {
|
|||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
const prompt = generatePrompt(envVars, mockGitHubData, false);
|
const prompt = generatePrompt(envVars, mockGitHubData, false, mockTagMode);
|
||||||
|
|
||||||
expect(prompt).toContain("<event_type>ISSUE_LABELED</event_type>");
|
expect(prompt).toContain("<event_type>ISSUE_LABELED</event_type>");
|
||||||
expect(prompt).toContain(
|
expect(prompt).toContain(
|
||||||
@@ -269,7 +293,7 @@ describe("generatePrompt", () => {
|
|||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
const prompt = generatePrompt(envVars, mockGitHubData, false);
|
const prompt = generatePrompt(envVars, mockGitHubData, false, mockTagMode);
|
||||||
|
|
||||||
expect(prompt).toContain("<direct_prompt>");
|
expect(prompt).toContain("<direct_prompt>");
|
||||||
expect(prompt).toContain("Fix the bug in the login form");
|
expect(prompt).toContain("Fix the bug in the login form");
|
||||||
@@ -292,7 +316,7 @@ describe("generatePrompt", () => {
|
|||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
const prompt = generatePrompt(envVars, mockGitHubData, false);
|
const prompt = generatePrompt(envVars, mockGitHubData, false, mockTagMode);
|
||||||
|
|
||||||
expect(prompt).toContain("<event_type>PULL_REQUEST</event_type>");
|
expect(prompt).toContain("<event_type>PULL_REQUEST</event_type>");
|
||||||
expect(prompt).toContain("<is_pr>true</is_pr>");
|
expect(prompt).toContain("<is_pr>true</is_pr>");
|
||||||
@@ -317,7 +341,7 @@ describe("generatePrompt", () => {
|
|||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
const prompt = generatePrompt(envVars, mockGitHubData, false);
|
const prompt = generatePrompt(envVars, mockGitHubData, false, mockTagMode);
|
||||||
|
|
||||||
expect(prompt).toContain("CUSTOM INSTRUCTIONS:\nAlways use TypeScript");
|
expect(prompt).toContain("CUSTOM INSTRUCTIONS:\nAlways use TypeScript");
|
||||||
});
|
});
|
||||||
@@ -336,7 +360,7 @@ describe("generatePrompt", () => {
|
|||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
const prompt = generatePrompt(envVars, mockGitHubData, false);
|
const prompt = generatePrompt(envVars, mockGitHubData, false, mockTagMode);
|
||||||
|
|
||||||
expect(prompt).toBe("Simple prompt for owner/repo PR #123");
|
expect(prompt).toBe("Simple prompt for owner/repo PR #123");
|
||||||
expect(prompt).not.toContain("You are Claude, an AI assistant");
|
expect(prompt).not.toContain("You are Claude, an AI assistant");
|
||||||
@@ -371,7 +395,7 @@ describe("generatePrompt", () => {
|
|||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
const prompt = generatePrompt(envVars, mockGitHubData, false);
|
const prompt = generatePrompt(envVars, mockGitHubData, false, mockTagMode);
|
||||||
|
|
||||||
expect(prompt).toContain("Repository: test/repo");
|
expect(prompt).toContain("Repository: test/repo");
|
||||||
expect(prompt).toContain("PR: 456");
|
expect(prompt).toContain("PR: 456");
|
||||||
@@ -418,7 +442,7 @@ describe("generatePrompt", () => {
|
|||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
const prompt = generatePrompt(envVars, issueGitHubData, false);
|
const prompt = generatePrompt(envVars, issueGitHubData, false, mockTagMode);
|
||||||
|
|
||||||
expect(prompt).toBe("Issue #789: Bug: Login form broken in owner/repo");
|
expect(prompt).toBe("Issue #789: Bug: Login form broken in owner/repo");
|
||||||
});
|
});
|
||||||
@@ -438,7 +462,7 @@ describe("generatePrompt", () => {
|
|||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
const prompt = generatePrompt(envVars, mockGitHubData, false);
|
const prompt = generatePrompt(envVars, mockGitHubData, false, mockTagMode);
|
||||||
|
|
||||||
expect(prompt).toBe("PR: 123, Issue: , Comment: ");
|
expect(prompt).toBe("PR: 123, Issue: , Comment: ");
|
||||||
});
|
});
|
||||||
@@ -458,7 +482,7 @@ describe("generatePrompt", () => {
|
|||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
const prompt = generatePrompt(envVars, mockGitHubData, false);
|
const prompt = generatePrompt(envVars, mockGitHubData, false, mockTagMode);
|
||||||
|
|
||||||
expect(prompt).toContain("You are Claude, an AI assistant");
|
expect(prompt).toContain("You are Claude, an AI assistant");
|
||||||
expect(prompt).toContain("<event_type>ISSUE_CREATED</event_type>");
|
expect(prompt).toContain("<event_type>ISSUE_CREATED</event_type>");
|
||||||
@@ -481,7 +505,7 @@ describe("generatePrompt", () => {
|
|||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
const prompt = generatePrompt(envVars, mockGitHubData, false);
|
const prompt = generatePrompt(envVars, mockGitHubData, false, mockTagMode);
|
||||||
|
|
||||||
expect(prompt).toContain("<trigger_username>johndoe</trigger_username>");
|
expect(prompt).toContain("<trigger_username>johndoe</trigger_username>");
|
||||||
// With commit signing disabled, co-author info appears in git commit instructions
|
// With commit signing disabled, co-author info appears in git commit instructions
|
||||||
@@ -503,7 +527,7 @@ describe("generatePrompt", () => {
|
|||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
const prompt = generatePrompt(envVars, mockGitHubData, false);
|
const prompt = generatePrompt(envVars, mockGitHubData, false, mockTagMode);
|
||||||
|
|
||||||
// Should contain PR-specific instructions (git commands when not using signing)
|
// Should contain PR-specific instructions (git commands when not using signing)
|
||||||
expect(prompt).toContain("git push");
|
expect(prompt).toContain("git push");
|
||||||
@@ -534,7 +558,7 @@ describe("generatePrompt", () => {
|
|||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
const prompt = generatePrompt(envVars, mockGitHubData, false);
|
const prompt = generatePrompt(envVars, mockGitHubData, false, mockTagMode);
|
||||||
|
|
||||||
// Should contain Issue-specific instructions
|
// Should contain Issue-specific instructions
|
||||||
expect(prompt).toContain(
|
expect(prompt).toContain(
|
||||||
@@ -573,7 +597,7 @@ describe("generatePrompt", () => {
|
|||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
const prompt = generatePrompt(envVars, mockGitHubData, false);
|
const prompt = generatePrompt(envVars, mockGitHubData, false, mockTagMode);
|
||||||
|
|
||||||
// Should contain the actual branch name with timestamp
|
// Should contain the actual branch name with timestamp
|
||||||
expect(prompt).toContain(
|
expect(prompt).toContain(
|
||||||
@@ -603,7 +627,7 @@ describe("generatePrompt", () => {
|
|||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
const prompt = generatePrompt(envVars, mockGitHubData, false);
|
const prompt = generatePrompt(envVars, mockGitHubData, false, mockTagMode);
|
||||||
|
|
||||||
// Should contain branch-specific instructions like issues
|
// Should contain branch-specific instructions like issues
|
||||||
expect(prompt).toContain(
|
expect(prompt).toContain(
|
||||||
@@ -641,7 +665,7 @@ describe("generatePrompt", () => {
|
|||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
const prompt = generatePrompt(envVars, mockGitHubData, false);
|
const prompt = generatePrompt(envVars, mockGitHubData, false, mockTagMode);
|
||||||
|
|
||||||
// Should contain open PR instructions (git commands when not using signing)
|
// Should contain open PR instructions (git commands when not using signing)
|
||||||
expect(prompt).toContain("git push");
|
expect(prompt).toContain("git push");
|
||||||
@@ -672,7 +696,7 @@ describe("generatePrompt", () => {
|
|||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
const prompt = generatePrompt(envVars, mockGitHubData, false);
|
const prompt = generatePrompt(envVars, mockGitHubData, false, mockTagMode);
|
||||||
|
|
||||||
// Should contain new branch instructions
|
// Should contain new branch instructions
|
||||||
expect(prompt).toContain(
|
expect(prompt).toContain(
|
||||||
@@ -700,7 +724,7 @@ describe("generatePrompt", () => {
|
|||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
const prompt = generatePrompt(envVars, mockGitHubData, false);
|
const prompt = generatePrompt(envVars, mockGitHubData, false, mockTagMode);
|
||||||
|
|
||||||
// Should contain new branch instructions
|
// Should contain new branch instructions
|
||||||
expect(prompt).toContain(
|
expect(prompt).toContain(
|
||||||
@@ -728,7 +752,7 @@ describe("generatePrompt", () => {
|
|||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
const prompt = generatePrompt(envVars, mockGitHubData, false);
|
const prompt = generatePrompt(envVars, mockGitHubData, false, mockTagMode);
|
||||||
|
|
||||||
// Should contain new branch instructions
|
// Should contain new branch instructions
|
||||||
expect(prompt).toContain(
|
expect(prompt).toContain(
|
||||||
@@ -752,7 +776,7 @@ describe("generatePrompt", () => {
|
|||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
const prompt = generatePrompt(envVars, mockGitHubData, false);
|
const prompt = generatePrompt(envVars, mockGitHubData, false, mockTagMode);
|
||||||
|
|
||||||
// Should have git command instructions
|
// Should have git command instructions
|
||||||
expect(prompt).toContain("Use git commands via the Bash tool");
|
expect(prompt).toContain("Use git commands via the Bash tool");
|
||||||
@@ -781,7 +805,7 @@ describe("generatePrompt", () => {
|
|||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
const prompt = generatePrompt(envVars, mockGitHubData, true);
|
const prompt = generatePrompt(envVars, mockGitHubData, true, mockTagMode);
|
||||||
|
|
||||||
// Should have commit signing tool instructions
|
// Should have commit signing tool instructions
|
||||||
expect(prompt).toContain("mcp__github_file_ops__commit_files");
|
expect(prompt).toContain("mcp__github_file_ops__commit_files");
|
||||||
@@ -1017,8 +1041,6 @@ describe("buildAllowedToolsString", () => {
|
|||||||
expect(result).toContain("Bash(git diff:*)");
|
expect(result).toContain("Bash(git diff:*)");
|
||||||
expect(result).toContain("Bash(git log:*)");
|
expect(result).toContain("Bash(git log:*)");
|
||||||
expect(result).toContain("Bash(git rm:*)");
|
expect(result).toContain("Bash(git rm:*)");
|
||||||
expect(result).toContain("Bash(git config user.name:*)");
|
|
||||||
expect(result).toContain("Bash(git config user.email:*)");
|
|
||||||
|
|
||||||
// Comment tool from minimal server should be included
|
// Comment tool from minimal server should be included
|
||||||
expect(result).toContain("mcp__github_comment__update_claude_comment");
|
expect(result).toContain("mcp__github_comment__update_claude_comment");
|
||||||
|
|||||||
10
test/fixtures/sample-turns-expected-output.md
vendored
10
test/fixtures/sample-turns-expected-output.md
vendored
@@ -28,7 +28,7 @@ if __name__ == "__main__":
|
|||||||
print(result)
|
print(result)
|
||||||
```
|
```
|
||||||
|
|
||||||
*Token usage: 100 input, 75 output*
|
*Token usage: 150 input, 75 output*
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -47,7 +47,7 @@ I can see the debug print statement that needs to be removed. Let me fix this by
|
|||||||
|
|
||||||
**→** File successfully edited. The debug print statement has been removed.
|
**→** File successfully edited. The debug print statement has been removed.
|
||||||
|
|
||||||
*Token usage: 200 input, 50 output*
|
*Token usage: 300 input, 50 output*
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -70,7 +70,7 @@ Perfect! I've successfully removed the debug print statement from the function.
|
|||||||
|
|
||||||
**→** Successfully posted review comment to PR #123
|
**→** Successfully posted review comment to PR #123
|
||||||
|
|
||||||
*Token usage: 150 input, 80 output*
|
*Token usage: 225 input, 80 output*
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -82,7 +82,7 @@ Great! I've successfully completed the requested task:
|
|||||||
|
|
||||||
The debug print statement has been removed as requested by the reviewers.
|
The debug print statement has been removed as requested by the reviewers.
|
||||||
|
|
||||||
*Token usage: 180 input, 60 output*
|
*Token usage: 270 input, 60 output*
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -91,5 +91,3 @@ The debug print statement has been removed as requested by the reviewers.
|
|||||||
Successfully removed debug print statement from file and added review comment to document the change.
|
Successfully removed debug print statement from file and added review comment to document the change.
|
||||||
|
|
||||||
**Cost:** $0.0347 | **Duration:** 18.8s
|
**Cost:** $0.0347 | **Duration:** 18.8s
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -662,4 +662,255 @@ describe("downloadCommentImages", () => {
|
|||||||
);
|
);
|
||||||
expect(result.get(imageUrl2)).toBeUndefined();
|
expect(result.get(imageUrl2)).toBeUndefined();
|
||||||
});
|
});
|
||||||
|
|
||||||
|
test("should detect and download images from HTML img tags", async () => {
|
||||||
|
const mockOctokit = createMockOctokit();
|
||||||
|
const imageUrl =
|
||||||
|
"https://github.com/user-attachments/assets/html-image.png";
|
||||||
|
const signedUrl =
|
||||||
|
"https://private-user-images.githubusercontent.com/html.png?jwt=token";
|
||||||
|
|
||||||
|
// Mock octokit response
|
||||||
|
// @ts-expect-error Mock implementation doesn't match full type signature
|
||||||
|
mockOctokit.rest.issues.getComment = jest.fn().mockResolvedValue({
|
||||||
|
data: {
|
||||||
|
body_html: `<img src="${signedUrl}">`,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// Mock fetch for image download
|
||||||
|
const mockArrayBuffer = new ArrayBuffer(8);
|
||||||
|
fetchSpy = spyOn(global, "fetch").mockResolvedValue({
|
||||||
|
ok: true,
|
||||||
|
arrayBuffer: async () => mockArrayBuffer,
|
||||||
|
} as Response);
|
||||||
|
|
||||||
|
const comments: CommentWithImages[] = [
|
||||||
|
{
|
||||||
|
type: "issue_comment",
|
||||||
|
id: "777",
|
||||||
|
body: `Here's an HTML image: <img src="${imageUrl}" alt="test">`,
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
const result = await downloadCommentImages(
|
||||||
|
mockOctokit,
|
||||||
|
"owner",
|
||||||
|
"repo",
|
||||||
|
comments,
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(mockOctokit.rest.issues.getComment).toHaveBeenCalledWith({
|
||||||
|
owner: "owner",
|
||||||
|
repo: "repo",
|
||||||
|
comment_id: 777,
|
||||||
|
mediaType: { format: "full+json" },
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(fetchSpy).toHaveBeenCalledWith(signedUrl);
|
||||||
|
expect(fsWriteFileSpy).toHaveBeenCalledWith(
|
||||||
|
"/tmp/github-images/image-1704067200000-0.png",
|
||||||
|
Buffer.from(mockArrayBuffer),
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(result.size).toBe(1);
|
||||||
|
expect(result.get(imageUrl)).toBe(
|
||||||
|
"/tmp/github-images/image-1704067200000-0.png",
|
||||||
|
);
|
||||||
|
expect(consoleLogSpy).toHaveBeenCalledWith(
|
||||||
|
"Found 1 image(s) in issue_comment 777",
|
||||||
|
);
|
||||||
|
expect(consoleLogSpy).toHaveBeenCalledWith(`Downloading ${imageUrl}...`);
|
||||||
|
expect(consoleLogSpy).toHaveBeenCalledWith(
|
||||||
|
"✓ Saved: /tmp/github-images/image-1704067200000-0.png",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should handle HTML img tags with different quote styles", async () => {
|
||||||
|
const mockOctokit = createMockOctokit();
|
||||||
|
const imageUrl1 =
|
||||||
|
"https://github.com/user-attachments/assets/single-quote.jpg";
|
||||||
|
const imageUrl2 =
|
||||||
|
"https://github.com/user-attachments/assets/double-quote.png";
|
||||||
|
const signedUrl1 =
|
||||||
|
"https://private-user-images.githubusercontent.com/single.jpg?jwt=token1";
|
||||||
|
const signedUrl2 =
|
||||||
|
"https://private-user-images.githubusercontent.com/double.png?jwt=token2";
|
||||||
|
|
||||||
|
// @ts-expect-error Mock implementation doesn't match full type signature
|
||||||
|
mockOctokit.rest.issues.getComment = jest.fn().mockResolvedValue({
|
||||||
|
data: {
|
||||||
|
body_html: `<img src="${signedUrl1}"><img src="${signedUrl2}">`,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
fetchSpy = spyOn(global, "fetch").mockResolvedValue({
|
||||||
|
ok: true,
|
||||||
|
arrayBuffer: async () => new ArrayBuffer(8),
|
||||||
|
} as Response);
|
||||||
|
|
||||||
|
const comments: CommentWithImages[] = [
|
||||||
|
{
|
||||||
|
type: "issue_comment",
|
||||||
|
id: "888",
|
||||||
|
body: `Single quote: <img src='${imageUrl1}' alt="test"> and double quote: <img src="${imageUrl2}" alt="test">`,
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
const result = await downloadCommentImages(
|
||||||
|
mockOctokit,
|
||||||
|
"owner",
|
||||||
|
"repo",
|
||||||
|
comments,
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(fetchSpy).toHaveBeenCalledTimes(2);
|
||||||
|
expect(result.size).toBe(2);
|
||||||
|
expect(result.get(imageUrl1)).toBe(
|
||||||
|
"/tmp/github-images/image-1704067200000-0.jpg",
|
||||||
|
);
|
||||||
|
expect(result.get(imageUrl2)).toBe(
|
||||||
|
"/tmp/github-images/image-1704067200000-1.png",
|
||||||
|
);
|
||||||
|
expect(consoleLogSpy).toHaveBeenCalledWith(
|
||||||
|
"Found 2 image(s) in issue_comment 888",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should handle mixed Markdown and HTML images", async () => {
|
||||||
|
const mockOctokit = createMockOctokit();
|
||||||
|
const markdownUrl =
|
||||||
|
"https://github.com/user-attachments/assets/markdown.png";
|
||||||
|
const htmlUrl = "https://github.com/user-attachments/assets/html.jpg";
|
||||||
|
const signedUrl1 =
|
||||||
|
"https://private-user-images.githubusercontent.com/md.png?jwt=token1";
|
||||||
|
const signedUrl2 =
|
||||||
|
"https://private-user-images.githubusercontent.com/html.jpg?jwt=token2";
|
||||||
|
|
||||||
|
// @ts-expect-error Mock implementation doesn't match full type signature
|
||||||
|
mockOctokit.rest.issues.getComment = jest.fn().mockResolvedValue({
|
||||||
|
data: {
|
||||||
|
body_html: `<img src="${signedUrl1}"><img src="${signedUrl2}">`,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
fetchSpy = spyOn(global, "fetch").mockResolvedValue({
|
||||||
|
ok: true,
|
||||||
|
arrayBuffer: async () => new ArrayBuffer(8),
|
||||||
|
} as Response);
|
||||||
|
|
||||||
|
const comments: CommentWithImages[] = [
|
||||||
|
{
|
||||||
|
type: "issue_comment",
|
||||||
|
id: "999",
|
||||||
|
body: `Markdown:  and HTML: <img src="${htmlUrl}" alt="test">`,
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
const result = await downloadCommentImages(
|
||||||
|
mockOctokit,
|
||||||
|
"owner",
|
||||||
|
"repo",
|
||||||
|
comments,
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(fetchSpy).toHaveBeenCalledTimes(2);
|
||||||
|
expect(result.size).toBe(2);
|
||||||
|
expect(result.get(markdownUrl)).toBe(
|
||||||
|
"/tmp/github-images/image-1704067200000-0.png",
|
||||||
|
);
|
||||||
|
expect(result.get(htmlUrl)).toBe(
|
||||||
|
"/tmp/github-images/image-1704067200000-1.jpg",
|
||||||
|
);
|
||||||
|
expect(consoleLogSpy).toHaveBeenCalledWith(
|
||||||
|
"Found 2 image(s) in issue_comment 999",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should deduplicate identical URLs from Markdown and HTML", async () => {
|
||||||
|
const mockOctokit = createMockOctokit();
|
||||||
|
const imageUrl = "https://github.com/user-attachments/assets/duplicate.png";
|
||||||
|
const signedUrl =
|
||||||
|
"https://private-user-images.githubusercontent.com/dup.png?jwt=token";
|
||||||
|
|
||||||
|
// @ts-expect-error Mock implementation doesn't match full type signature
|
||||||
|
mockOctokit.rest.issues.getComment = jest.fn().mockResolvedValue({
|
||||||
|
data: {
|
||||||
|
body_html: `<img src="${signedUrl}">`,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
fetchSpy = spyOn(global, "fetch").mockResolvedValue({
|
||||||
|
ok: true,
|
||||||
|
arrayBuffer: async () => new ArrayBuffer(8),
|
||||||
|
} as Response);
|
||||||
|
|
||||||
|
const comments: CommentWithImages[] = [
|
||||||
|
{
|
||||||
|
type: "issue_comment",
|
||||||
|
id: "1000",
|
||||||
|
body: `Same image twice:  and <img src="${imageUrl}" alt="test">`,
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
const result = await downloadCommentImages(
|
||||||
|
mockOctokit,
|
||||||
|
"owner",
|
||||||
|
"repo",
|
||||||
|
comments,
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(fetchSpy).toHaveBeenCalledTimes(1); // Only downloaded once
|
||||||
|
expect(result.size).toBe(1);
|
||||||
|
expect(result.get(imageUrl)).toBe(
|
||||||
|
"/tmp/github-images/image-1704067200000-0.png",
|
||||||
|
);
|
||||||
|
expect(consoleLogSpy).toHaveBeenCalledWith(
|
||||||
|
"Found 1 image(s) in issue_comment 1000",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should handle HTML img tags with additional attributes", async () => {
|
||||||
|
const mockOctokit = createMockOctokit();
|
||||||
|
const imageUrl =
|
||||||
|
"https://github.com/user-attachments/assets/complex-tag.webp";
|
||||||
|
const signedUrl =
|
||||||
|
"https://private-user-images.githubusercontent.com/complex.webp?jwt=token";
|
||||||
|
|
||||||
|
// @ts-expect-error Mock implementation doesn't match full type signature
|
||||||
|
mockOctokit.rest.issues.getComment = jest.fn().mockResolvedValue({
|
||||||
|
data: {
|
||||||
|
body_html: `<img src="${signedUrl}">`,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
fetchSpy = spyOn(global, "fetch").mockResolvedValue({
|
||||||
|
ok: true,
|
||||||
|
arrayBuffer: async () => new ArrayBuffer(8),
|
||||||
|
} as Response);
|
||||||
|
|
||||||
|
const comments: CommentWithImages[] = [
|
||||||
|
{
|
||||||
|
type: "issue_comment",
|
||||||
|
id: "1001",
|
||||||
|
body: `Complex tag: <img class="image" src="${imageUrl}" alt="test image" width="100" height="200">`,
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
const result = await downloadCommentImages(
|
||||||
|
mockOctokit,
|
||||||
|
"owner",
|
||||||
|
"repo",
|
||||||
|
comments,
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(fetchSpy).toHaveBeenCalledTimes(1);
|
||||||
|
expect(result.size).toBe(1);
|
||||||
|
expect(result.get(imageUrl)).toBe(
|
||||||
|
"/tmp/github-images/image-1704067200000-0.webp",
|
||||||
|
);
|
||||||
|
expect(consoleLogSpy).toHaveBeenCalledWith(
|
||||||
|
"Found 1 image(s) in issue_comment 1001",
|
||||||
|
);
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -37,6 +37,7 @@ describe("prepareMcpConfig", () => {
|
|||||||
useStickyComment: false,
|
useStickyComment: false,
|
||||||
additionalPermissions: new Map(),
|
additionalPermissions: new Map(),
|
||||||
useCommitSigning: false,
|
useCommitSigning: false,
|
||||||
|
allowedBots: "",
|
||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -547,8 +548,8 @@ describe("prepareMcpConfig", () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
test("should include github_ci server when context.isPR is true and actions:read permission is granted", async () => {
|
test("should include github_ci server when context.isPR is true and actions:read permission is granted", async () => {
|
||||||
const oldEnv = process.env.ACTIONS_TOKEN;
|
const oldEnv = process.env.DEFAULT_WORKFLOW_TOKEN;
|
||||||
process.env.ACTIONS_TOKEN = "workflow-token";
|
process.env.DEFAULT_WORKFLOW_TOKEN = "workflow-token";
|
||||||
|
|
||||||
const contextWithPermissions = {
|
const contextWithPermissions = {
|
||||||
...mockPRContext,
|
...mockPRContext,
|
||||||
@@ -575,7 +576,7 @@ describe("prepareMcpConfig", () => {
|
|||||||
expect(parsed.mcpServers.github_ci.env.PR_NUMBER).toBe("456");
|
expect(parsed.mcpServers.github_ci.env.PR_NUMBER).toBe("456");
|
||||||
expect(parsed.mcpServers.github_file_ops).toBeDefined();
|
expect(parsed.mcpServers.github_file_ops).toBeDefined();
|
||||||
|
|
||||||
process.env.ACTIONS_TOKEN = oldEnv;
|
process.env.DEFAULT_WORKFLOW_TOKEN = oldEnv;
|
||||||
});
|
});
|
||||||
|
|
||||||
test("should not include github_ci server when context.isPR is false", async () => {
|
test("should not include github_ci server when context.isPR is false", async () => {
|
||||||
@@ -595,8 +596,8 @@ describe("prepareMcpConfig", () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
test("should not include github_ci server when actions:read permission is not granted", async () => {
|
test("should not include github_ci server when actions:read permission is not granted", async () => {
|
||||||
const oldTokenEnv = process.env.ACTIONS_TOKEN;
|
const oldTokenEnv = process.env.DEFAULT_WORKFLOW_TOKEN;
|
||||||
process.env.ACTIONS_TOKEN = "workflow-token";
|
process.env.DEFAULT_WORKFLOW_TOKEN = "workflow-token";
|
||||||
|
|
||||||
const result = await prepareMcpConfig({
|
const result = await prepareMcpConfig({
|
||||||
githubToken: "test-token",
|
githubToken: "test-token",
|
||||||
@@ -612,12 +613,12 @@ describe("prepareMcpConfig", () => {
|
|||||||
expect(parsed.mcpServers.github_ci).not.toBeDefined();
|
expect(parsed.mcpServers.github_ci).not.toBeDefined();
|
||||||
expect(parsed.mcpServers.github_file_ops).toBeDefined();
|
expect(parsed.mcpServers.github_file_ops).toBeDefined();
|
||||||
|
|
||||||
process.env.ACTIONS_TOKEN = oldTokenEnv;
|
process.env.DEFAULT_WORKFLOW_TOKEN = oldTokenEnv;
|
||||||
});
|
});
|
||||||
|
|
||||||
test("should parse additional_permissions with multiple lines correctly", async () => {
|
test("should parse additional_permissions with multiple lines correctly", async () => {
|
||||||
const oldTokenEnv = process.env.ACTIONS_TOKEN;
|
const oldTokenEnv = process.env.DEFAULT_WORKFLOW_TOKEN;
|
||||||
process.env.ACTIONS_TOKEN = "workflow-token";
|
process.env.DEFAULT_WORKFLOW_TOKEN = "workflow-token";
|
||||||
|
|
||||||
const contextWithPermissions = {
|
const contextWithPermissions = {
|
||||||
...mockPRContext,
|
...mockPRContext,
|
||||||
@@ -644,12 +645,12 @@ describe("prepareMcpConfig", () => {
|
|||||||
expect(parsed.mcpServers.github_ci).toBeDefined();
|
expect(parsed.mcpServers.github_ci).toBeDefined();
|
||||||
expect(parsed.mcpServers.github_ci.env.GITHUB_TOKEN).toBe("workflow-token");
|
expect(parsed.mcpServers.github_ci.env.GITHUB_TOKEN).toBe("workflow-token");
|
||||||
|
|
||||||
process.env.ACTIONS_TOKEN = oldTokenEnv;
|
process.env.DEFAULT_WORKFLOW_TOKEN = oldTokenEnv;
|
||||||
});
|
});
|
||||||
|
|
||||||
test("should warn when actions:read is requested but token lacks permission", async () => {
|
test("should warn when actions:read is requested but token lacks permission", async () => {
|
||||||
const oldTokenEnv = process.env.ACTIONS_TOKEN;
|
const oldTokenEnv = process.env.DEFAULT_WORKFLOW_TOKEN;
|
||||||
process.env.ACTIONS_TOKEN = "invalid-token";
|
process.env.DEFAULT_WORKFLOW_TOKEN = "invalid-token";
|
||||||
|
|
||||||
const contextWithPermissions = {
|
const contextWithPermissions = {
|
||||||
...mockPRContext,
|
...mockPRContext,
|
||||||
@@ -677,6 +678,6 @@ describe("prepareMcpConfig", () => {
|
|||||||
),
|
),
|
||||||
);
|
);
|
||||||
|
|
||||||
process.env.ACTIONS_TOKEN = oldTokenEnv;
|
process.env.DEFAULT_WORKFLOW_TOKEN = oldTokenEnv;
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -28,6 +28,7 @@ const defaultInputs = {
|
|||||||
useStickyComment: false,
|
useStickyComment: false,
|
||||||
additionalPermissions: new Map<string, string>(),
|
additionalPermissions: new Map<string, string>(),
|
||||||
useCommitSigning: false,
|
useCommitSigning: false,
|
||||||
|
allowedBots: "",
|
||||||
};
|
};
|
||||||
|
|
||||||
const defaultRepository = {
|
const defaultRepository = {
|
||||||
|
|||||||
@@ -1,15 +1,29 @@
|
|||||||
import { describe, test, expect, beforeEach } from "bun:test";
|
import { describe, test, expect, beforeEach, afterEach, spyOn } from "bun:test";
|
||||||
import { agentMode } from "../../src/modes/agent";
|
import { agentMode } from "../../src/modes/agent";
|
||||||
import type { GitHubContext } from "../../src/github/context";
|
import type { GitHubContext } from "../../src/github/context";
|
||||||
import { createMockContext, createMockAutomationContext } from "../mockContext";
|
import { createMockContext, createMockAutomationContext } from "../mockContext";
|
||||||
|
import * as core from "@actions/core";
|
||||||
|
|
||||||
describe("Agent Mode", () => {
|
describe("Agent Mode", () => {
|
||||||
let mockContext: GitHubContext;
|
let mockContext: GitHubContext;
|
||||||
|
let exportVariableSpy: any;
|
||||||
|
let setOutputSpy: any;
|
||||||
|
|
||||||
beforeEach(() => {
|
beforeEach(() => {
|
||||||
mockContext = createMockAutomationContext({
|
mockContext = createMockAutomationContext({
|
||||||
eventName: "workflow_dispatch",
|
eventName: "workflow_dispatch",
|
||||||
});
|
});
|
||||||
|
exportVariableSpy = spyOn(core, "exportVariable").mockImplementation(
|
||||||
|
() => {},
|
||||||
|
);
|
||||||
|
setOutputSpy = spyOn(core, "setOutput").mockImplementation(() => {});
|
||||||
|
});
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
exportVariableSpy?.mockClear();
|
||||||
|
setOutputSpy?.mockClear();
|
||||||
|
exportVariableSpy?.mockRestore();
|
||||||
|
setOutputSpy?.mockRestore();
|
||||||
});
|
});
|
||||||
|
|
||||||
test("agent mode has correct properties", () => {
|
test("agent mode has correct properties", () => {
|
||||||
@@ -56,4 +70,67 @@ describe("Agent Mode", () => {
|
|||||||
expect(agentMode.shouldTrigger(context)).toBe(false);
|
expect(agentMode.shouldTrigger(context)).toBe(false);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
test("prepare method sets up tools environment variables correctly", async () => {
|
||||||
|
// Clear any previous calls before this test
|
||||||
|
exportVariableSpy.mockClear();
|
||||||
|
setOutputSpy.mockClear();
|
||||||
|
|
||||||
|
const contextWithCustomTools = createMockAutomationContext({
|
||||||
|
eventName: "workflow_dispatch",
|
||||||
|
});
|
||||||
|
contextWithCustomTools.inputs.allowedTools = ["CustomTool1", "CustomTool2"];
|
||||||
|
contextWithCustomTools.inputs.disallowedTools = ["BadTool"];
|
||||||
|
|
||||||
|
const mockOctokit = {} as any;
|
||||||
|
const result = await agentMode.prepare({
|
||||||
|
context: contextWithCustomTools,
|
||||||
|
octokit: mockOctokit,
|
||||||
|
githubToken: "test-token",
|
||||||
|
});
|
||||||
|
|
||||||
|
// Verify that both ALLOWED_TOOLS and DISALLOWED_TOOLS are set
|
||||||
|
expect(exportVariableSpy).toHaveBeenCalledWith(
|
||||||
|
"ALLOWED_TOOLS",
|
||||||
|
"Edit,MultiEdit,Glob,Grep,LS,Read,Write,CustomTool1,CustomTool2",
|
||||||
|
);
|
||||||
|
expect(exportVariableSpy).toHaveBeenCalledWith(
|
||||||
|
"DISALLOWED_TOOLS",
|
||||||
|
"WebSearch,WebFetch,BadTool",
|
||||||
|
);
|
||||||
|
|
||||||
|
// Verify MCP config is set
|
||||||
|
expect(setOutputSpy).toHaveBeenCalledWith("mcp_config", expect.any(String));
|
||||||
|
|
||||||
|
// Verify return structure
|
||||||
|
expect(result).toEqual({
|
||||||
|
commentId: undefined,
|
||||||
|
branchInfo: {
|
||||||
|
baseBranch: "",
|
||||||
|
currentBranch: "",
|
||||||
|
claudeBranch: undefined,
|
||||||
|
},
|
||||||
|
mcpConfig: expect.any(String),
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
test("prepare method creates prompt file with correct content", async () => {
|
||||||
|
const contextWithPrompts = createMockAutomationContext({
|
||||||
|
eventName: "workflow_dispatch",
|
||||||
|
});
|
||||||
|
contextWithPrompts.inputs.overridePrompt = "Custom override prompt";
|
||||||
|
contextWithPrompts.inputs.directPrompt =
|
||||||
|
"Direct prompt (should be ignored)";
|
||||||
|
|
||||||
|
const mockOctokit = {} as any;
|
||||||
|
await agentMode.prepare({
|
||||||
|
context: contextWithPrompts,
|
||||||
|
octokit: mockOctokit,
|
||||||
|
githubToken: "test-token",
|
||||||
|
});
|
||||||
|
|
||||||
|
// Note: We can't easily test file creation in this unit test,
|
||||||
|
// but we can verify the method completes without errors
|
||||||
|
expect(setOutputSpy).toHaveBeenCalledWith("mcp_config", expect.any(String));
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -3,6 +3,7 @@ import { getMode, isValidMode } from "../../src/modes/registry";
|
|||||||
import type { ModeName } from "../../src/modes/types";
|
import type { ModeName } from "../../src/modes/types";
|
||||||
import { tagMode } from "../../src/modes/tag";
|
import { tagMode } from "../../src/modes/tag";
|
||||||
import { agentMode } from "../../src/modes/agent";
|
import { agentMode } from "../../src/modes/agent";
|
||||||
|
import { reviewMode } from "../../src/modes/review";
|
||||||
import { createMockContext, createMockAutomationContext } from "../mockContext";
|
import { createMockContext, createMockAutomationContext } from "../mockContext";
|
||||||
|
|
||||||
describe("Mode Registry", () => {
|
describe("Mode Registry", () => {
|
||||||
@@ -30,6 +31,12 @@ describe("Mode Registry", () => {
|
|||||||
expect(mode.name).toBe("agent");
|
expect(mode.name).toBe("agent");
|
||||||
});
|
});
|
||||||
|
|
||||||
|
test("getMode returns experimental-review mode", () => {
|
||||||
|
const mode = getMode("experimental-review", mockContext);
|
||||||
|
expect(mode).toBe(reviewMode);
|
||||||
|
expect(mode.name).toBe("experimental-review");
|
||||||
|
});
|
||||||
|
|
||||||
test("getMode throws error for tag mode with workflow_dispatch event", () => {
|
test("getMode throws error for tag mode with workflow_dispatch event", () => {
|
||||||
expect(() => getMode("tag", mockWorkflowDispatchContext)).toThrow(
|
expect(() => getMode("tag", mockWorkflowDispatchContext)).toThrow(
|
||||||
"Tag mode cannot handle workflow_dispatch events. Use 'agent' mode for automation events.",
|
"Tag mode cannot handle workflow_dispatch events. Use 'agent' mode for automation events.",
|
||||||
@@ -57,17 +64,17 @@ describe("Mode Registry", () => {
|
|||||||
test("getMode throws error for invalid mode", () => {
|
test("getMode throws error for invalid mode", () => {
|
||||||
const invalidMode = "invalid" as unknown as ModeName;
|
const invalidMode = "invalid" as unknown as ModeName;
|
||||||
expect(() => getMode(invalidMode, mockContext)).toThrow(
|
expect(() => getMode(invalidMode, mockContext)).toThrow(
|
||||||
"Invalid mode 'invalid'. Valid modes are: 'tag', 'agent'. Please check your workflow configuration.",
|
"Invalid mode 'invalid'. Valid modes are: 'tag', 'agent', 'experimental-review'. Please check your workflow configuration.",
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
test("isValidMode returns true for all valid modes", () => {
|
test("isValidMode returns true for all valid modes", () => {
|
||||||
expect(isValidMode("tag")).toBe(true);
|
expect(isValidMode("tag")).toBe(true);
|
||||||
expect(isValidMode("agent")).toBe(true);
|
expect(isValidMode("agent")).toBe(true);
|
||||||
|
expect(isValidMode("experimental-review")).toBe(true);
|
||||||
});
|
});
|
||||||
|
|
||||||
test("isValidMode returns false for invalid mode", () => {
|
test("isValidMode returns false for invalid mode", () => {
|
||||||
expect(isValidMode("invalid")).toBe(false);
|
expect(isValidMode("invalid")).toBe(false);
|
||||||
expect(isValidMode("review")).toBe(false);
|
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -73,6 +73,7 @@ describe("checkWritePermissions", () => {
|
|||||||
useStickyComment: false,
|
useStickyComment: false,
|
||||||
additionalPermissions: new Map(),
|
additionalPermissions: new Map(),
|
||||||
useCommitSigning: false,
|
useCommitSigning: false,
|
||||||
|
allowedBots: "",
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -126,6 +127,16 @@ describe("checkWritePermissions", () => {
|
|||||||
);
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
test("should return true for bot user", async () => {
|
||||||
|
const mockOctokit = createMockOctokit("none");
|
||||||
|
const context = createContext();
|
||||||
|
context.actor = "test-bot[bot]";
|
||||||
|
|
||||||
|
const result = await checkWritePermissions(mockOctokit, context);
|
||||||
|
|
||||||
|
expect(result).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
test("should throw error when permission check fails", async () => {
|
test("should throw error when permission check fails", async () => {
|
||||||
const error = new Error("API error");
|
const error = new Error("API error");
|
||||||
const mockOctokit = {
|
const mockOctokit = {
|
||||||
|
|||||||
@@ -7,6 +7,7 @@ import {
|
|||||||
normalizeHtmlEntities,
|
normalizeHtmlEntities,
|
||||||
sanitizeContent,
|
sanitizeContent,
|
||||||
stripHtmlComments,
|
stripHtmlComments,
|
||||||
|
redactGitHubTokens,
|
||||||
} from "../src/github/utils/sanitizer";
|
} from "../src/github/utils/sanitizer";
|
||||||
|
|
||||||
describe("stripInvisibleCharacters", () => {
|
describe("stripInvisibleCharacters", () => {
|
||||||
@@ -242,6 +243,109 @@ describe("sanitizeContent", () => {
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
describe("redactGitHubTokens", () => {
|
||||||
|
it("should redact personal access tokens (ghp_)", () => {
|
||||||
|
const token = "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";
|
||||||
|
expect(redactGitHubTokens(`Token: ${token}`)).toBe(
|
||||||
|
"Token: [REDACTED_GITHUB_TOKEN]",
|
||||||
|
);
|
||||||
|
expect(redactGitHubTokens(`Here's a token: ${token} in text`)).toBe(
|
||||||
|
"Here's a token: [REDACTED_GITHUB_TOKEN] in text",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should redact OAuth tokens (gho_)", () => {
|
||||||
|
const token = "gho_16C7e42F292c6912E7710c838347Ae178B4a";
|
||||||
|
expect(redactGitHubTokens(`OAuth: ${token}`)).toBe(
|
||||||
|
"OAuth: [REDACTED_GITHUB_TOKEN]",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should redact installation tokens (ghs_)", () => {
|
||||||
|
const token = "ghs_xz7yzju2SZjGPa0dUNMAx0SH4xDOCS31LXQW";
|
||||||
|
expect(redactGitHubTokens(`Install token: ${token}`)).toBe(
|
||||||
|
"Install token: [REDACTED_GITHUB_TOKEN]",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should redact refresh tokens (ghr_)", () => {
|
||||||
|
const token = "ghr_1B4a2e77838347a253e56d7b5253e7d11667";
|
||||||
|
expect(redactGitHubTokens(`Refresh: ${token}`)).toBe(
|
||||||
|
"Refresh: [REDACTED_GITHUB_TOKEN]",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should redact fine-grained tokens (github_pat_)", () => {
|
||||||
|
const token =
|
||||||
|
"github_pat_11ABCDEFG0example5of9_2nVwvsylpmOLboQwTPTLewDcE621dQ0AAaBBCCDDEEFFHH";
|
||||||
|
expect(redactGitHubTokens(`Fine-grained: ${token}`)).toBe(
|
||||||
|
"Fine-grained: [REDACTED_GITHUB_TOKEN]",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should handle tokens in code blocks", () => {
|
||||||
|
const content = `\`\`\`bash
|
||||||
|
export GITHUB_TOKEN=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
|
||||||
|
\`\`\``;
|
||||||
|
const expected = `\`\`\`bash
|
||||||
|
export GITHUB_TOKEN=[REDACTED_GITHUB_TOKEN]
|
||||||
|
\`\`\``;
|
||||||
|
expect(redactGitHubTokens(content)).toBe(expected);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should handle multiple tokens in one text", () => {
|
||||||
|
const content =
|
||||||
|
"Token 1: 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 and token 2: gho_16C7e42F292c6912E7710c838347Ae178B4a";
|
||||||
|
expect(redactGitHubTokens(content)).toBe(
|
||||||
|
"Token 1: [REDACTED_GITHUB_TOKEN] and token 2: [REDACTED_GITHUB_TOKEN]",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should handle tokens in URLs", () => {
|
||||||
|
const content =
|
||||||
|
"https://api.github.com/user?access_token=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";
|
||||||
|
expect(redactGitHubTokens(content)).toBe(
|
||||||
|
"https://api.github.com/user?access_token=[REDACTED_GITHUB_TOKEN]",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should not redact partial matches or invalid tokens", () => {
|
||||||
|
const content =
|
||||||
|
"This is not a token: ghp_short or gho_toolong1234567890123456789012345678901234567890";
|
||||||
|
expect(redactGitHubTokens(content)).toBe(content);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should preserve normal text", () => {
|
||||||
|
const content = "Normal text with no tokens";
|
||||||
|
expect(redactGitHubTokens(content)).toBe(content);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should handle edge cases", () => {
|
||||||
|
expect(redactGitHubTokens("")).toBe("");
|
||||||
|
expect(redactGitHubTokens("ghp_")).toBe("ghp_");
|
||||||
|
expect(redactGitHubTokens("github_pat_short")).toBe("github_pat_short");
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("sanitizeContent with token redaction", () => {
|
||||||
|
it("should redact tokens as part of full sanitization", () => {
|
||||||
|
const content = `
|
||||||
|
<!-- Hidden comment with token: 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 -->
|
||||||
|
Here's some text with a token: gho_16C7e42F292c6912E7710c838347Ae178B4a
|
||||||
|
And invisible chars: test\u200Btoken
|
||||||
|
`;
|
||||||
|
|
||||||
|
const sanitized = sanitizeContent(content);
|
||||||
|
|
||||||
|
expect(sanitized).not.toContain("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");
|
||||||
|
expect(sanitized).not.toContain("gho_16C7e42F292c6912E7710c838347Ae178B4a");
|
||||||
|
expect(sanitized).not.toContain("<!-- Hidden comment");
|
||||||
|
expect(sanitized).not.toContain("\u200B");
|
||||||
|
expect(sanitized).toContain("[REDACTED_GITHUB_TOKEN]");
|
||||||
|
expect(sanitized).toContain("Here's some text with a token:");
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
describe("stripHtmlComments (legacy)", () => {
|
describe("stripHtmlComments (legacy)", () => {
|
||||||
it("should remove HTML comments", () => {
|
it("should remove HTML comments", () => {
|
||||||
expect(stripHtmlComments("Hello <!-- example -->World")).toBe(
|
expect(stripHtmlComments("Hello <!-- example -->World")).toBe(
|
||||||
|
|||||||
@@ -41,6 +41,7 @@ describe("checkContainsTrigger", () => {
|
|||||||
useStickyComment: false,
|
useStickyComment: false,
|
||||||
additionalPermissions: new Map(),
|
additionalPermissions: new Map(),
|
||||||
useCommitSigning: false,
|
useCommitSigning: false,
|
||||||
|
allowedBots: "",
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
expect(checkContainsTrigger(context)).toBe(true);
|
expect(checkContainsTrigger(context)).toBe(true);
|
||||||
@@ -74,6 +75,7 @@ describe("checkContainsTrigger", () => {
|
|||||||
useStickyComment: false,
|
useStickyComment: false,
|
||||||
additionalPermissions: new Map(),
|
additionalPermissions: new Map(),
|
||||||
useCommitSigning: false,
|
useCommitSigning: false,
|
||||||
|
allowedBots: "",
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
expect(checkContainsTrigger(context)).toBe(false);
|
expect(checkContainsTrigger(context)).toBe(false);
|
||||||
@@ -291,6 +293,7 @@ describe("checkContainsTrigger", () => {
|
|||||||
useStickyComment: false,
|
useStickyComment: false,
|
||||||
additionalPermissions: new Map(),
|
additionalPermissions: new Map(),
|
||||||
useCommitSigning: false,
|
useCommitSigning: false,
|
||||||
|
allowedBots: "",
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
expect(checkContainsTrigger(context)).toBe(true);
|
expect(checkContainsTrigger(context)).toBe(true);
|
||||||
@@ -325,6 +328,7 @@ describe("checkContainsTrigger", () => {
|
|||||||
useStickyComment: false,
|
useStickyComment: false,
|
||||||
additionalPermissions: new Map(),
|
additionalPermissions: new Map(),
|
||||||
useCommitSigning: false,
|
useCommitSigning: false,
|
||||||
|
allowedBots: "",
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
expect(checkContainsTrigger(context)).toBe(true);
|
expect(checkContainsTrigger(context)).toBe(true);
|
||||||
@@ -359,6 +363,7 @@ describe("checkContainsTrigger", () => {
|
|||||||
useStickyComment: false,
|
useStickyComment: false,
|
||||||
additionalPermissions: new Map(),
|
additionalPermissions: new Map(),
|
||||||
useCommitSigning: false,
|
useCommitSigning: false,
|
||||||
|
allowedBots: "",
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
expect(checkContainsTrigger(context)).toBe(false);
|
expect(checkContainsTrigger(context)).toBe(false);
|
||||||
|
|||||||
Reference in New Issue
Block a user