mirror of
https://github.com/anthropics/claude-code-action.git
synced 2026-01-23 23:14:13 +08:00
Compare commits
24 Commits
test-auto-
...
v1.0.2
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
0c127307fa | ||
|
|
8a20581ed5 | ||
|
|
a2ad6b7b4e | ||
|
|
f0925925f1 | ||
|
|
ef8c0a650e | ||
|
|
dd49718216 | ||
|
|
be4b56e1ea | ||
|
|
dfef61fdee | ||
|
|
5218d84d4f | ||
|
|
c05ccc5ce4 | ||
|
|
41e5ba9012 | ||
|
|
e6f32c8321 | ||
|
|
ada5bc42eb | ||
|
|
d6d3ddd4a7 | ||
|
|
0630ef383a | ||
|
|
9c7e1bac94 | ||
|
|
dc65f4ac98 | ||
|
|
88be3fe6f5 | ||
|
|
a47fdbe49f | ||
|
|
28f8362010 | ||
|
|
9f02f6f6d4 | ||
|
|
79cee96324 | ||
|
|
194fca8b05 | ||
|
|
0f913a6e0e |
8
.github/workflows/claude.yml
vendored
8
.github/workflows/claude.yml
vendored
@@ -31,9 +31,9 @@ jobs:
|
|||||||
|
|
||||||
- name: Run Claude Code
|
- name: Run Claude Code
|
||||||
id: claude
|
id: claude
|
||||||
uses: anthropics/claude-code-action@beta
|
uses: anthropics/claude-code-action@v1
|
||||||
with:
|
with:
|
||||||
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)"
|
claude_args: |
|
||||||
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."
|
--allowedTools "Bash(bun install),Bash(bun test:*),Bash(bun run format),Bash(bun typecheck)"
|
||||||
model: "claude-opus-4-1-20250805"
|
--model "claude-opus-4-1-20250805"
|
||||||
|
|||||||
10
.github/workflows/issue-triage.yml
vendored
10
.github/workflows/issue-triage.yml
vendored
@@ -97,12 +97,12 @@ jobs:
|
|||||||
EOF
|
EOF
|
||||||
|
|
||||||
- name: Run Claude Code for Issue Triage
|
- name: Run Claude Code for Issue Triage
|
||||||
uses: anthropics/claude-code-base-action@beta
|
uses: anthropics/claude-code-base-action@v1
|
||||||
with:
|
with:
|
||||||
prompt_file: /tmp/claude-prompts/triage-prompt.txt
|
prompt: $(cat /tmp/claude-prompts/triage-prompt.txt)
|
||||||
allowed_tools: "Bash(gh label list),mcp__github__get_issue,mcp__github__get_issue_comments,mcp__github__update_issue,mcp__github__search_issues,mcp__github__list_issues"
|
|
||||||
mcp_config: /tmp/mcp-config/mcp-servers.json
|
|
||||||
timeout_minutes: "5"
|
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
|
claude_args: |
|
||||||
|
--allowedTools Bash(gh label list),mcp__github__get_issue,mcp__github__get_issue_comments,mcp__github__update_issue,mcp__github__search_issues,mcp__github__list_issues
|
||||||
|
--mcp-config /tmp/mcp-config/mcp-servers.json
|
||||||
env:
|
env:
|
||||||
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
|||||||
85
.github/workflows/release.yml
vendored
85
.github/workflows/release.yml
vendored
@@ -80,38 +80,7 @@ jobs:
|
|||||||
gh release create "$next_version" \
|
gh release create "$next_version" \
|
||||||
--title "$next_version" \
|
--title "$next_version" \
|
||||||
--generate-notes \
|
--generate-notes \
|
||||||
--latest=false # We want to keep beta as the latest
|
--latest=false # keep v1 as latest
|
||||||
|
|
||||||
update-beta-tag:
|
|
||||||
needs: create-release
|
|
||||||
if: ${{ !inputs.dry_run }}
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
environment: production
|
|
||||||
permissions:
|
|
||||||
contents: write
|
|
||||||
steps:
|
|
||||||
- name: Checkout code
|
|
||||||
uses: actions/checkout@v4
|
|
||||||
with:
|
|
||||||
fetch-depth: 0
|
|
||||||
|
|
||||||
- name: Update beta tag
|
|
||||||
run: |
|
|
||||||
# Get the latest version tag
|
|
||||||
VERSION=$(git tag -l 'v[0-9]*' | sort -V | tail -1)
|
|
||||||
|
|
||||||
# Update the beta tag to point to this release
|
|
||||||
git config user.name "github-actions[bot]"
|
|
||||||
git config user.email "github-actions[bot]@users.noreply.github.com"
|
|
||||||
git tag -fa beta -m "Update beta tag to ${VERSION}"
|
|
||||||
git push origin beta --force
|
|
||||||
|
|
||||||
- name: Update beta release to be latest
|
|
||||||
env:
|
|
||||||
GH_TOKEN: ${{ github.token }}
|
|
||||||
run: |
|
|
||||||
# Update beta release to be marked as latest
|
|
||||||
gh release edit beta --latest
|
|
||||||
|
|
||||||
update-major-tag:
|
update-major-tag:
|
||||||
needs: create-release
|
needs: create-release
|
||||||
@@ -153,35 +122,35 @@ jobs:
|
|||||||
token: ${{ secrets.CLAUDE_CODE_BASE_ACTION_PAT }}
|
token: ${{ secrets.CLAUDE_CODE_BASE_ACTION_PAT }}
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
|
|
||||||
- name: Create and push tag
|
# - name: Create and push tag
|
||||||
run: |
|
# run: |
|
||||||
next_version="${{ needs.create-release.outputs.next_version }}"
|
# next_version="${{ needs.create-release.outputs.next_version }}"
|
||||||
|
|
||||||
git config user.name "github-actions[bot]"
|
# git config user.name "github-actions[bot]"
|
||||||
git config user.email "github-actions[bot]@users.noreply.github.com"
|
# git config user.email "github-actions[bot]@users.noreply.github.com"
|
||||||
|
|
||||||
# Create the version tag
|
# # Create the version tag
|
||||||
git tag -a "$next_version" -m "Release $next_version - synced from claude-code-action"
|
# git tag -a "$next_version" -m "Release $next_version - synced from claude-code-action"
|
||||||
git push origin "$next_version"
|
# git push origin "$next_version"
|
||||||
|
|
||||||
# Update the beta tag
|
# # Update the beta tag
|
||||||
git tag -fa beta -m "Update beta tag to ${next_version}"
|
# git tag -fa beta -m "Update beta tag to ${next_version}"
|
||||||
git push origin beta --force
|
# git push origin beta --force
|
||||||
|
|
||||||
- name: Create GitHub release
|
# - name: Create GitHub release
|
||||||
env:
|
# env:
|
||||||
GH_TOKEN: ${{ secrets.CLAUDE_CODE_BASE_ACTION_PAT }}
|
# GH_TOKEN: ${{ secrets.CLAUDE_CODE_BASE_ACTION_PAT }}
|
||||||
run: |
|
# run: |
|
||||||
next_version="${{ needs.create-release.outputs.next_version }}"
|
# next_version="${{ needs.create-release.outputs.next_version }}"
|
||||||
|
|
||||||
# Create the release
|
# # Create the release
|
||||||
gh release create "$next_version" \
|
# gh release create "$next_version" \
|
||||||
--repo anthropics/claude-code-base-action \
|
# --repo anthropics/claude-code-base-action \
|
||||||
--title "$next_version" \
|
# --title "$next_version" \
|
||||||
--notes "Release $next_version - synced from anthropics/claude-code-action" \
|
# --notes "Release $next_version - synced from anthropics/claude-code-action" \
|
||||||
--latest=false
|
# --latest=false
|
||||||
|
|
||||||
# Update beta release to be latest
|
# # Update beta release to be latest
|
||||||
gh release edit beta \
|
# gh release edit beta \
|
||||||
--repo anthropics/claude-code-base-action \
|
# --repo anthropics/claude-code-base-action \
|
||||||
--latest
|
# --latest
|
||||||
|
|||||||
2
.github/workflows/test-base-action.yml
vendored
2
.github/workflows/test-base-action.yml
vendored
@@ -25,7 +25,6 @@ jobs:
|
|||||||
prompt: ${{ github.event.inputs.test_prompt || 'List the files in the current directory starting with "package"' }}
|
prompt: ${{ github.event.inputs.test_prompt || 'List the files in the current directory starting with "package"' }}
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
allowed_tools: "LS,Read"
|
allowed_tools: "LS,Read"
|
||||||
timeout_minutes: "3"
|
|
||||||
|
|
||||||
- name: Verify inline prompt output
|
- name: Verify inline prompt output
|
||||||
run: |
|
run: |
|
||||||
@@ -83,7 +82,6 @@ jobs:
|
|||||||
prompt_file: "test-prompt.txt"
|
prompt_file: "test-prompt.txt"
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
allowed_tools: "LS,Read"
|
allowed_tools: "LS,Read"
|
||||||
timeout_minutes: "3"
|
|
||||||
|
|
||||||
- name: Verify prompt file output
|
- name: Verify prompt file output
|
||||||
run: |
|
run: |
|
||||||
|
|||||||
89
.github/workflows/test-custom-executables.yml
vendored
Normal file
89
.github/workflows/test-custom-executables.yml
vendored
Normal file
@@ -0,0 +1,89 @@
|
|||||||
|
name: Test Custom Executables
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
pull_request:
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
test-custom-executables:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
|
||||||
|
|
||||||
|
- name: Install Bun manually
|
||||||
|
run: |
|
||||||
|
echo "Installing Bun..."
|
||||||
|
curl -fsSL https://bun.sh/install | bash
|
||||||
|
echo "Bun installed at: $HOME/.bun/bin/bun"
|
||||||
|
|
||||||
|
# Verify Bun installation
|
||||||
|
if [ -f "$HOME/.bun/bin/bun" ]; then
|
||||||
|
echo "✅ Bun executable found"
|
||||||
|
$HOME/.bun/bin/bun --version
|
||||||
|
else
|
||||||
|
echo "❌ Bun executable not found"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
- name: Install Claude Code manually
|
||||||
|
run: |
|
||||||
|
echo "Installing Claude Code..."
|
||||||
|
curl -fsSL https://claude.ai/install.sh | bash -s latest
|
||||||
|
echo "Claude Code installed at: $HOME/.local/bin/claude"
|
||||||
|
|
||||||
|
# Verify Claude installation
|
||||||
|
if [ -f "$HOME/.local/bin/claude" ]; then
|
||||||
|
echo "✅ Claude executable found"
|
||||||
|
ls -la "$HOME/.local/bin/claude"
|
||||||
|
else
|
||||||
|
echo "❌ Claude executable not found"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
- name: Test with both custom executables
|
||||||
|
id: custom-test
|
||||||
|
uses: ./base-action
|
||||||
|
with:
|
||||||
|
prompt: |
|
||||||
|
List the files in the current directory starting with "package"
|
||||||
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
|
path_to_claude_code_executable: /home/runner/.local/bin/claude
|
||||||
|
path_to_bun_executable: /home/runner/.bun/bin/bun
|
||||||
|
allowed_tools: "LS,Read"
|
||||||
|
|
||||||
|
- name: Verify custom executables worked
|
||||||
|
run: |
|
||||||
|
OUTPUT_FILE="${{ steps.custom-test.outputs.execution_file }}"
|
||||||
|
CONCLUSION="${{ steps.custom-test.outputs.conclusion }}"
|
||||||
|
|
||||||
|
echo "Conclusion: $CONCLUSION"
|
||||||
|
echo "Output file: $OUTPUT_FILE"
|
||||||
|
|
||||||
|
if [ "$CONCLUSION" = "success" ]; then
|
||||||
|
echo "✅ Action completed successfully with both custom executables"
|
||||||
|
else
|
||||||
|
echo "❌ Action failed with custom executables"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ -f "$OUTPUT_FILE" ] && [ -s "$OUTPUT_FILE" ]; then
|
||||||
|
echo "✅ Execution log file created successfully"
|
||||||
|
if jq . "$OUTPUT_FILE" > /dev/null 2>&1; then
|
||||||
|
echo "✅ Output is valid JSON"
|
||||||
|
# Verify the task was completed
|
||||||
|
if grep -q "package" "$OUTPUT_FILE"; then
|
||||||
|
echo "✅ Claude successfully listed package files"
|
||||||
|
else
|
||||||
|
echo "⚠️ Could not verify if package files were listed"
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
echo "❌ Output is not valid JSON"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
echo "❌ Execution log file not found or empty"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
4
.github/workflows/test-settings.yml
vendored
4
.github/workflows/test-settings.yml
vendored
@@ -26,7 +26,6 @@ jobs:
|
|||||||
"allow": ["Bash(echo:*)"]
|
"allow": ["Bash(echo:*)"]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
timeout_minutes: "2"
|
|
||||||
|
|
||||||
- name: Verify echo worked
|
- name: Verify echo worked
|
||||||
run: |
|
run: |
|
||||||
@@ -76,7 +75,6 @@ jobs:
|
|||||||
"deny": ["Bash(echo:*)"]
|
"deny": ["Bash(echo:*)"]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
timeout_minutes: "2"
|
|
||||||
|
|
||||||
- name: Verify echo was denied
|
- name: Verify echo was denied
|
||||||
run: |
|
run: |
|
||||||
@@ -114,7 +112,6 @@ jobs:
|
|||||||
Use Bash to echo "Hello from settings file test"
|
Use Bash to echo "Hello from settings file test"
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
settings: "test-settings.json"
|
settings: "test-settings.json"
|
||||||
timeout_minutes: "2"
|
|
||||||
|
|
||||||
- name: Verify echo worked
|
- name: Verify echo worked
|
||||||
run: |
|
run: |
|
||||||
@@ -169,7 +166,6 @@ jobs:
|
|||||||
Use Bash to echo "This should not work from file"
|
Use Bash to echo "This should not work from file"
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
settings: "test-settings.json"
|
settings: "test-settings.json"
|
||||||
timeout_minutes: "2"
|
|
||||||
|
|
||||||
- name: Verify echo was denied
|
- name: Verify echo was denied
|
||||||
run: |
|
run: |
|
||||||
|
|||||||
24
.github/workflows/update-major-tag.yml
vendored
24
.github/workflows/update-major-tag.yml
vendored
@@ -1,24 +0,0 @@
|
|||||||
name: Update Beta Tag
|
|
||||||
|
|
||||||
on:
|
|
||||||
release:
|
|
||||||
types: [published]
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
update-beta-tag:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
permissions:
|
|
||||||
contents: write
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- name: Update beta tag
|
|
||||||
run: |
|
|
||||||
# Get the current release version
|
|
||||||
VERSION=${GITHUB_REF#refs/tags/}
|
|
||||||
|
|
||||||
# Update the beta tag to point to this release
|
|
||||||
git config user.name github-actions[bot]
|
|
||||||
git config user.email github-actions[bot]@users.noreply.github.com
|
|
||||||
git tag -fa beta -m "Update beta tag to ${VERSION}"
|
|
||||||
git push origin beta --force
|
|
||||||
@@ -1,175 +0,0 @@
|
|||||||
# Auto-Fix CI Workflow Implementation Checkpoint
|
|
||||||
|
|
||||||
## Overview
|
|
||||||
This document captures the learnings from implementing auto-fix CI workflows that allow Claude to automatically fix CI failures and post as claude[bot].
|
|
||||||
|
|
||||||
## Journey Summary
|
|
||||||
|
|
||||||
### Initial Goal
|
|
||||||
Create an auto-fix CI workflow similar to Cursor's implementation that:
|
|
||||||
1. Detects CI failures on PRs
|
|
||||||
2. Automatically triggers Claude to fix the issues
|
|
||||||
3. Creates branches with fixes
|
|
||||||
4. Posts PR comments as claude[bot] (not github-actions[bot])
|
|
||||||
|
|
||||||
### Key Implementation Files
|
|
||||||
|
|
||||||
#### 1. Auto-Fix Workflow
|
|
||||||
**File**: `.github/workflows/auto-fix-ci-inline.yml`
|
|
||||||
- Triggers on `workflow_run` event when CI fails
|
|
||||||
- Creates fix branch
|
|
||||||
- Collects failure logs
|
|
||||||
- Calls Claude Code Action with `/fix-ci` slash command
|
|
||||||
- Posts PR comment with fix branch link
|
|
||||||
|
|
||||||
#### 2. Fix-CI Slash Command
|
|
||||||
**File**: `.claude/commands/fix-ci.md`
|
|
||||||
- Contains all instructions for analyzing and fixing CI failures
|
|
||||||
- Handles test failures, type errors, linting issues
|
|
||||||
- Commits and pushes fixes
|
|
||||||
|
|
||||||
#### 3. Claude Code Action Changes (v1-dev branch)
|
|
||||||
**Modified Files**:
|
|
||||||
- `src/entrypoints/prepare.ts` - Exposes GitHub token as output
|
|
||||||
- `action.yml` - Adds github_token output definition
|
|
||||||
|
|
||||||
## Critical Discoveries
|
|
||||||
|
|
||||||
### 1. Authentication Architecture
|
|
||||||
|
|
||||||
#### How Tag Mode Works (Success Case)
|
|
||||||
1. User comments "@claude" on PR → `issue_comment` event
|
|
||||||
2. Action requests OIDC token with audience "claude-code-github-action"
|
|
||||||
3. Token exchange at `api.anthropic.com/api/github/github-app-token-exchange`
|
|
||||||
4. Backend validates event type is in allowed list
|
|
||||||
5. Returns Claude App token → posts as claude[bot]
|
|
||||||
|
|
||||||
#### Why Workflow_Run Failed
|
|
||||||
1. Auto-fix workflow triggers on `workflow_run` event
|
|
||||||
2. OIDC token has `event_name: "workflow_run"` claim
|
|
||||||
3. Backend's `allowed_events` list didn't include "workflow_run"
|
|
||||||
4. Token exchange fails with "401 Unauthorized - Invalid OIDC token"
|
|
||||||
5. Can't get Claude App token → falls back to github-actions[bot]
|
|
||||||
|
|
||||||
### 2. OIDC Token Claims
|
|
||||||
GitHub Actions OIDC tokens include:
|
|
||||||
- `event_name`: The triggering event (pull_request, issue_comment, workflow_run, etc.)
|
|
||||||
- `repository`: The repo where action runs
|
|
||||||
- `actor`: Who triggered the action
|
|
||||||
- `job_workflow_ref`: Reference to the workflow file
|
|
||||||
- And many other claims for verification
|
|
||||||
|
|
||||||
### 3. Backend Validation
|
|
||||||
**File**: `anthropic/api/api/private_api/routes/github/github_app_token_exchange.py`
|
|
||||||
|
|
||||||
The backend validates:
|
|
||||||
```python
|
|
||||||
allowed_events = [
|
|
||||||
"pull_request",
|
|
||||||
"issue_comment",
|
|
||||||
"pull_request_comment",
|
|
||||||
"issues",
|
|
||||||
"pull_request_review",
|
|
||||||
"pull_request_review_comment",
|
|
||||||
"repository_dispatch",
|
|
||||||
"workflow_dispatch",
|
|
||||||
"schedule",
|
|
||||||
# "workflow_run" was missing!
|
|
||||||
]
|
|
||||||
```
|
|
||||||
|
|
||||||
### 4. Agent Mode vs Tag Mode
|
|
||||||
- **Tag Mode**: Triggers on PR/issue events, creates tracking comments
|
|
||||||
- **Agent Mode**: Triggers on automation events (workflow_dispatch, schedule, and now workflow_run)
|
|
||||||
- Both modes can use Claude App token if event is in allowed list
|
|
||||||
|
|
||||||
## Solution Implemented
|
|
||||||
|
|
||||||
### Backend Change (PR Created)
|
|
||||||
Add `"workflow_run"` to the `allowed_events` list in the Claude backend to enable OIDC token exchange for workflow_run events.
|
|
||||||
|
|
||||||
### Why This Works
|
|
||||||
- No special handling needed for different event types
|
|
||||||
- Backend treats all allowed events the same way
|
|
||||||
- Just validates token, checks permissions, returns Claude App token
|
|
||||||
- Event name only used for validation and logging/metrics
|
|
||||||
|
|
||||||
## Current Status
|
|
||||||
|
|
||||||
### Completed
|
|
||||||
- ✅ Created auto-fix workflow and slash command
|
|
||||||
- ✅ Modified Claude Code Action to expose GitHub token as output
|
|
||||||
- ✅ Identified root cause of authentication failure
|
|
||||||
- ✅ Created PR to add workflow_run to backend allowed events
|
|
||||||
|
|
||||||
### Waiting On
|
|
||||||
- ⏳ Backend PR approval and deployment
|
|
||||||
- ⏳ Testing with updated backend
|
|
||||||
|
|
||||||
## Next Steps
|
|
||||||
|
|
||||||
Once the backend PR is merged and deployed:
|
|
||||||
|
|
||||||
### 1. Test Auto-Fix Workflow
|
|
||||||
- Create a test PR with intentional CI failures
|
|
||||||
- Verify auto-fix workflow triggers
|
|
||||||
- Confirm Claude can authenticate via OIDC
|
|
||||||
- Verify comments come from claude[bot]
|
|
||||||
|
|
||||||
### 2. Potential Improvements
|
|
||||||
- Add more sophisticated CI failure detection
|
|
||||||
- Handle different types of failures (tests, linting, types, build)
|
|
||||||
- Add progress indicators in PR comments
|
|
||||||
- Consider batching multiple fixes
|
|
||||||
- Add retry logic for transient failures
|
|
||||||
|
|
||||||
### 3. Documentation
|
|
||||||
- Document the auto-fix workflow setup
|
|
||||||
- Create examples for different CI systems
|
|
||||||
- Add troubleshooting guide
|
|
||||||
|
|
||||||
### 4. Extended Features
|
|
||||||
- Support for multiple CI workflows
|
|
||||||
- Customizable fix strategies per project
|
|
||||||
- Integration with other GitHub Actions events
|
|
||||||
- Support for monorepo structures
|
|
||||||
|
|
||||||
## Alternative Approaches (If Backend Change Blocked)
|
|
||||||
|
|
||||||
### Option 1: Repository Dispatch
|
|
||||||
Instead of `workflow_run`, use `repository_dispatch`:
|
|
||||||
- Original workflow triggers dispatch event on failure
|
|
||||||
- Auto-fix workflow responds to dispatch event
|
|
||||||
- Works today without backend changes
|
|
||||||
|
|
||||||
### Option 2: Direct PR Event
|
|
||||||
Trigger on `pull_request` with conditional logic:
|
|
||||||
- Check CI status in the workflow
|
|
||||||
- Only run if CI failed
|
|
||||||
- Keeps PR context for OIDC exchange
|
|
||||||
|
|
||||||
### Option 3: Custom GitHub App
|
|
||||||
Create separate GitHub App for auto-fix:
|
|
||||||
- Has its own authentication
|
|
||||||
- Posts as custom bot (not claude[bot])
|
|
||||||
- More complex but fully independent
|
|
||||||
|
|
||||||
## Key Learnings
|
|
||||||
|
|
||||||
1. **OIDC Context Matters**: The event context in OIDC tokens determines authentication success
|
|
||||||
2. **Backend Validation is Simple**: Just a list check, no complex event-specific logic
|
|
||||||
3. **Agent Mode is Powerful**: Designed for automation, just needed backend support
|
|
||||||
4. **Token Flow is Critical**: Understanding the full auth flow helped identify the issue
|
|
||||||
5. **Incremental Solutions Work**: Start simple, identify blockers, fix systematically
|
|
||||||
|
|
||||||
## Resources
|
|
||||||
|
|
||||||
- [GitHub Actions OIDC Documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
|
|
||||||
- [Claude Code Action Repository](https://github.com/anthropics/claude-code-action)
|
|
||||||
- [Backend PR for workflow_run support](#) (Add link when available)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
*Last Updated: 2025-08-20*
|
|
||||||
*Session Duration: ~6 hours*
|
|
||||||
*Key Achievement: Identified and resolved Claude App authentication for workflow_run events*
|
|
||||||
18
README.md
18
README.md
@@ -2,10 +2,11 @@
|
|||||||
|
|
||||||
# Claude Code Action
|
# Claude Code Action
|
||||||
|
|
||||||
A general-purpose [Claude Code](https://claude.ai/code) action for GitHub PRs and issues that can answer questions and implement code changes. This action listens for a trigger phrase in comments and activates Claude act on the request. It supports multiple authentication methods including Anthropic direct API, Amazon Bedrock, and Google Vertex AI.
|
A general-purpose [Claude Code](https://claude.ai/code) action for GitHub PRs and issues that can answer questions and implement code changes. This action intelligently detects when to activate based on your workflow context—whether responding to @claude mentions, issue assignments, or executing automation tasks with explicit prompts. It supports multiple authentication methods including Anthropic direct API, Amazon Bedrock, and Google Vertex AI.
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
|
- 🎯 **Intelligent Mode Detection**: Automatically selects the appropriate execution mode based on your workflow context—no configuration needed
|
||||||
- 🤖 **Interactive Code Assistant**: Claude can answer questions about code, architecture, and programming
|
- 🤖 **Interactive Code Assistant**: Claude can answer questions about code, architecture, and programming
|
||||||
- 🔍 **Code Review**: Analyzes PR changes and suggests improvements
|
- 🔍 **Code Review**: Analyzes PR changes and suggests improvements
|
||||||
- ✨ **Code Implementation**: Can implement simple fixes, refactoring, and even new features
|
- ✨ **Code Implementation**: Can implement simple fixes, refactoring, and even new features
|
||||||
@@ -13,19 +14,11 @@ A general-purpose [Claude Code](https://claude.ai/code) action for GitHub PRs an
|
|||||||
- 🛠️ **Flexible Tool Access**: Access to GitHub APIs and file operations (additional tools can be enabled via configuration)
|
- 🛠️ **Flexible Tool Access**: Access to GitHub APIs and file operations (additional tools can be enabled via configuration)
|
||||||
- 📋 **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)
|
||||||
|
- ⚙️ **Simplified Configuration**: Unified `prompt` and `claude_args` inputs provide clean, powerful configuration aligned with Claude Code SDK
|
||||||
|
|
||||||
## ⚠️ **BREAKING CHANGES COMING IN v1.0** ⚠️
|
## 📦 Upgrading from v0.x?
|
||||||
|
|
||||||
**We're planning a major update that will significantly change how this action works.** The new version will:
|
**See our [Migration Guide](./docs/migration-guide.md)** for step-by-step instructions on updating your workflows to v1.0. The new version simplifies configuration while maintaining compatibility with most existing setups.
|
||||||
|
|
||||||
- ✨ 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
|
||||||
|
|
||||||
@@ -40,6 +33,7 @@ This command will guide you through setting up the GitHub app and required secre
|
|||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
|
- **[Migration Guide](./docs/migration-guide.md)** - **⭐ Upgrading from v0.x to v1.0**
|
||||||
- [Setup Guide](./docs/setup.md) - Manual setup, custom GitHub apps, and security best practices
|
- [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
|
- [Usage Guide](./docs/usage.md) - Basic usage, workflow configuration, and input parameters
|
||||||
- [Custom Automations](./docs/custom-automations.md) - Examples of automated workflows and custom prompts
|
- [Custom Automations](./docs/custom-automations.md) - Examples of automated workflows and custom prompts
|
||||||
|
|||||||
45
action.yml
45
action.yml
@@ -57,18 +57,10 @@ inputs:
|
|||||||
required: false
|
required: false
|
||||||
default: "false"
|
default: "false"
|
||||||
|
|
||||||
timeout_minutes:
|
|
||||||
description: "Timeout in minutes for execution"
|
|
||||||
required: false
|
|
||||||
default: "30"
|
|
||||||
claude_args:
|
claude_args:
|
||||||
description: "Additional arguments to pass directly to Claude CLI"
|
description: "Additional arguments to pass directly to Claude CLI"
|
||||||
required: false
|
required: false
|
||||||
default: ""
|
default: ""
|
||||||
mcp_config:
|
|
||||||
description: "Additional MCP configuration (JSON string) that merges with built-in GitHub MCP servers"
|
|
||||||
required: false
|
|
||||||
default: ""
|
|
||||||
additional_permissions:
|
additional_permissions:
|
||||||
description: "Additional GitHub permissions to request (e.g., 'actions: read')"
|
description: "Additional GitHub permissions to request (e.g., 'actions: read')"
|
||||||
required: false
|
required: false
|
||||||
@@ -85,6 +77,14 @@ inputs:
|
|||||||
description: "Restrict network access to these domains only (newline-separated). If not set, no restrictions are applied. Provider domains are auto-detected."
|
description: "Restrict network access to these domains only (newline-separated). If not set, no restrictions are applied. Provider domains are auto-detected."
|
||||||
required: false
|
required: false
|
||||||
default: ""
|
default: ""
|
||||||
|
path_to_claude_code_executable:
|
||||||
|
description: "Optional path to a custom Claude Code executable. If provided, skips automatic installation and uses this executable instead. WARNING: Using an older version may cause problems if the action begins taking advantage of new Claude Code features. This input is typically not needed unless you're debugging something specific or have unique needs in your environment."
|
||||||
|
required: false
|
||||||
|
default: ""
|
||||||
|
path_to_bun_executable:
|
||||||
|
description: "Optional path to a custom Bun executable. If provided, skips automatic Bun installation and uses this executable instead. WARNING: Using an incompatible version may cause problems if the action requires specific Bun features. This input is typically not needed unless you're debugging something specific or have unique needs in your environment."
|
||||||
|
required: false
|
||||||
|
default: ""
|
||||||
|
|
||||||
outputs:
|
outputs:
|
||||||
execution_file:
|
execution_file:
|
||||||
@@ -101,10 +101,20 @@ runs:
|
|||||||
using: "composite"
|
using: "composite"
|
||||||
steps:
|
steps:
|
||||||
- name: Install Bun
|
- name: Install Bun
|
||||||
|
if: inputs.path_to_bun_executable == ''
|
||||||
uses: oven-sh/setup-bun@735343b667d3e6f658f44d0eca948eb6282f2b76 # https://github.com/oven-sh/setup-bun/releases/tag/v2.0.2
|
uses: oven-sh/setup-bun@735343b667d3e6f658f44d0eca948eb6282f2b76 # https://github.com/oven-sh/setup-bun/releases/tag/v2.0.2
|
||||||
with:
|
with:
|
||||||
bun-version: 1.2.11
|
bun-version: 1.2.11
|
||||||
|
|
||||||
|
- name: Setup Custom Bun Path
|
||||||
|
if: inputs.path_to_bun_executable != ''
|
||||||
|
shell: bash
|
||||||
|
run: |
|
||||||
|
echo "Using custom Bun executable: ${{ inputs.path_to_bun_executable }}"
|
||||||
|
# Add the directory containing the custom executable to PATH
|
||||||
|
BUN_DIR=$(dirname "${{ inputs.path_to_bun_executable }}")
|
||||||
|
echo "$BUN_DIR" >> "$GITHUB_PATH"
|
||||||
|
|
||||||
- name: Install Dependencies
|
- name: Install Dependencies
|
||||||
shell: bash
|
shell: bash
|
||||||
run: |
|
run: |
|
||||||
@@ -132,7 +142,6 @@ runs:
|
|||||||
USE_COMMIT_SIGNING: ${{ inputs.use_commit_signing }}
|
USE_COMMIT_SIGNING: ${{ inputs.use_commit_signing }}
|
||||||
ADDITIONAL_PERMISSIONS: ${{ inputs.additional_permissions }}
|
ADDITIONAL_PERMISSIONS: ${{ inputs.additional_permissions }}
|
||||||
CLAUDE_ARGS: ${{ inputs.claude_args }}
|
CLAUDE_ARGS: ${{ inputs.claude_args }}
|
||||||
MCP_CONFIG: ${{ inputs.mcp_config }}
|
|
||||||
ALL_INPUTS: ${{ toJson(inputs) }}
|
ALL_INPUTS: ${{ toJson(inputs) }}
|
||||||
|
|
||||||
- name: Install Base Action Dependencies
|
- name: Install Base Action Dependencies
|
||||||
@@ -144,9 +153,18 @@ runs:
|
|||||||
bun install
|
bun install
|
||||||
echo "Base-action dependencies installed"
|
echo "Base-action dependencies installed"
|
||||||
cd -
|
cd -
|
||||||
# Install Claude Code globally
|
|
||||||
curl -fsSL https://claude.ai/install.sh | bash -s 1.0.84
|
# Install Claude Code if no custom executable is provided
|
||||||
echo "$HOME/.local/bin" >> "$GITHUB_PATH"
|
if [ -z "${{ inputs.path_to_claude_code_executable }}" ]; then
|
||||||
|
echo "Installing Claude Code..."
|
||||||
|
curl -fsSL https://claude.ai/install.sh | bash -s 1.0.96
|
||||||
|
echo "$HOME/.local/bin" >> "$GITHUB_PATH"
|
||||||
|
else
|
||||||
|
echo "Using custom Claude Code executable: ${{ inputs.path_to_claude_code_executable }}"
|
||||||
|
# Add the directory containing the custom executable to PATH
|
||||||
|
CLAUDE_DIR=$(dirname "${{ inputs.path_to_claude_code_executable }}")
|
||||||
|
echo "$CLAUDE_DIR" >> "$GITHUB_PATH"
|
||||||
|
fi
|
||||||
|
|
||||||
- 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 != ''
|
||||||
@@ -170,10 +188,11 @@ runs:
|
|||||||
CLAUDE_CODE_ACTION: "1"
|
CLAUDE_CODE_ACTION: "1"
|
||||||
INPUT_PROMPT_FILE: ${{ runner.temp }}/claude-prompts/claude-prompt.txt
|
INPUT_PROMPT_FILE: ${{ runner.temp }}/claude-prompts/claude-prompt.txt
|
||||||
INPUT_SETTINGS: ${{ inputs.settings }}
|
INPUT_SETTINGS: ${{ inputs.settings }}
|
||||||
INPUT_TIMEOUT_MINUTES: ${{ inputs.timeout_minutes }}
|
|
||||||
INPUT_CLAUDE_ARGS: ${{ steps.prepare.outputs.claude_args }}
|
INPUT_CLAUDE_ARGS: ${{ steps.prepare.outputs.claude_args }}
|
||||||
INPUT_EXPERIMENTAL_SLASH_COMMANDS_DIR: ${{ github.action_path }}/slash-commands
|
INPUT_EXPERIMENTAL_SLASH_COMMANDS_DIR: ${{ github.action_path }}/slash-commands
|
||||||
INPUT_ACTION_INPUTS_PRESENT: ${{ steps.prepare.outputs.action_inputs_present }}
|
INPUT_ACTION_INPUTS_PRESENT: ${{ steps.prepare.outputs.action_inputs_present }}
|
||||||
|
INPUT_PATH_TO_CLAUDE_CODE_EXECUTABLE: ${{ inputs.path_to_claude_code_executable }}
|
||||||
|
INPUT_PATH_TO_BUN_EXECUTABLE: ${{ inputs.path_to_bun_executable }}
|
||||||
|
|
||||||
# Model configuration
|
# Model configuration
|
||||||
GITHUB_TOKEN: ${{ steps.prepare.outputs.GITHUB_TOKEN }}
|
GITHUB_TOKEN: ${{ steps.prepare.outputs.GITHUB_TOKEN }}
|
||||||
|
|||||||
@@ -100,7 +100,6 @@ Add the following to your workflow file:
|
|||||||
| `model` | Model to use (provider-specific format required for Bedrock/Vertex) | No | 'claude-4-0-sonnet-20250219' |
|
| `model` | Model to use (provider-specific format required for Bedrock/Vertex) | No | 'claude-4-0-sonnet-20250219' |
|
||||||
| `anthropic_model` | DEPRECATED: Use 'model' instead | No | 'claude-4-0-sonnet-20250219' |
|
| `anthropic_model` | DEPRECATED: Use 'model' instead | No | 'claude-4-0-sonnet-20250219' |
|
||||||
| `fallback_model` | Enable automatic fallback to specified model when default model is overloaded | No | '' |
|
| `fallback_model` | Enable automatic fallback to specified model when default model is overloaded | No | '' |
|
||||||
| `timeout_minutes` | Timeout in minutes for Claude Code execution | No | '10' |
|
|
||||||
| `anthropic_api_key` | Anthropic API key (required for direct Anthropic API) | No | '' |
|
| `anthropic_api_key` | Anthropic API key (required for direct Anthropic API) | No | '' |
|
||||||
| `claude_code_oauth_token` | Claude Code OAuth token (alternative to anthropic_api_key) | No | '' |
|
| `claude_code_oauth_token` | Claude Code OAuth token (alternative to anthropic_api_key) | No | '' |
|
||||||
| `use_bedrock` | Use Amazon Bedrock with OIDC authentication instead of direct Anthropic API | No | 'false' |
|
| `use_bedrock` | Use Amazon Bedrock with OIDC authentication instead of direct Anthropic API | No | 'false' |
|
||||||
@@ -320,7 +319,6 @@ You can combine MCP config with other inputs like allowed tools:
|
|||||||
prompt: "Access the custom MCP server and use its tools"
|
prompt: "Access the custom MCP server and use its tools"
|
||||||
mcp_config: "mcp-config.json"
|
mcp_config: "mcp-config.json"
|
||||||
allowed_tools: "Bash(git:*),View,mcp__server-name__custom_tool"
|
allowed_tools: "Bash(git:*),View,mcp__server-name__custom_tool"
|
||||||
timeout_minutes: "15"
|
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -20,17 +20,10 @@ inputs:
|
|||||||
default: ""
|
default: ""
|
||||||
|
|
||||||
# Action settings
|
# Action settings
|
||||||
timeout_minutes:
|
|
||||||
description: "Timeout in minutes for Claude Code execution"
|
|
||||||
required: false
|
|
||||||
default: "10"
|
|
||||||
claude_args:
|
claude_args:
|
||||||
description: "Additional arguments to pass directly to Claude CLI (e.g., '--max-turns 3 --mcp-config /path/to/config.json')"
|
description: "Additional arguments to pass directly to Claude CLI (e.g., '--max-turns 3 --mcp-config /path/to/config.json')"
|
||||||
required: false
|
required: false
|
||||||
default: ""
|
default: ""
|
||||||
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:
|
||||||
@@ -54,6 +47,14 @@ inputs:
|
|||||||
description: "Whether to use Node.js dependency caching (set to true only for Node.js projects with lock files)"
|
description: "Whether to use Node.js dependency caching (set to true only for Node.js projects with lock files)"
|
||||||
required: false
|
required: false
|
||||||
default: "false"
|
default: "false"
|
||||||
|
path_to_claude_code_executable:
|
||||||
|
description: "Optional path to a custom Claude Code executable. If provided, skips automatic installation and uses this executable instead. WARNING: Using an older version may cause problems if the action begins taking advantage of new Claude Code features. This input is typically not needed unless you're debugging something specific or have unique needs in your environment."
|
||||||
|
required: false
|
||||||
|
default: ""
|
||||||
|
path_to_bun_executable:
|
||||||
|
description: "Optional path to a custom Bun executable. If provided, skips automatic Bun installation and uses this executable instead. WARNING: Using an incompatible version may cause problems if the action requires specific Bun features. This input is typically not needed unless you're debugging something specific or have unique needs in your environment."
|
||||||
|
required: false
|
||||||
|
default: ""
|
||||||
|
|
||||||
outputs:
|
outputs:
|
||||||
conclusion:
|
conclusion:
|
||||||
@@ -73,10 +74,20 @@ runs:
|
|||||||
cache: ${{ inputs.use_node_cache == 'true' && 'npm' || '' }}
|
cache: ${{ inputs.use_node_cache == 'true' && 'npm' || '' }}
|
||||||
|
|
||||||
- name: Install Bun
|
- name: Install Bun
|
||||||
|
if: inputs.path_to_bun_executable == ''
|
||||||
uses: oven-sh/setup-bun@735343b667d3e6f658f44d0eca948eb6282f2b76 # https://github.com/oven-sh/setup-bun/releases/tag/v2.0.2
|
uses: oven-sh/setup-bun@735343b667d3e6f658f44d0eca948eb6282f2b76 # https://github.com/oven-sh/setup-bun/releases/tag/v2.0.2
|
||||||
with:
|
with:
|
||||||
bun-version: 1.2.11
|
bun-version: 1.2.11
|
||||||
|
|
||||||
|
- name: Setup Custom Bun Path
|
||||||
|
if: inputs.path_to_bun_executable != ''
|
||||||
|
shell: bash
|
||||||
|
run: |
|
||||||
|
echo "Using custom Bun executable: ${{ inputs.path_to_bun_executable }}"
|
||||||
|
# Add the directory containing the custom executable to PATH
|
||||||
|
BUN_DIR=$(dirname "${{ inputs.path_to_bun_executable }}")
|
||||||
|
echo "$BUN_DIR" >> "$GITHUB_PATH"
|
||||||
|
|
||||||
- name: Install Dependencies
|
- name: Install Dependencies
|
||||||
shell: bash
|
shell: bash
|
||||||
run: |
|
run: |
|
||||||
@@ -85,7 +96,16 @@ runs:
|
|||||||
|
|
||||||
- name: Install Claude Code
|
- name: Install Claude Code
|
||||||
shell: bash
|
shell: bash
|
||||||
run: curl -fsSL https://claude.ai/install.sh | bash -s 1.0.84
|
run: |
|
||||||
|
if [ -z "${{ inputs.path_to_claude_code_executable }}" ]; then
|
||||||
|
echo "Installing Claude Code..."
|
||||||
|
curl -fsSL https://claude.ai/install.sh | bash -s 1.0.96
|
||||||
|
else
|
||||||
|
echo "Using custom Claude Code executable: ${{ inputs.path_to_claude_code_executable }}"
|
||||||
|
# Add the directory containing the custom executable to PATH
|
||||||
|
CLAUDE_DIR=$(dirname "${{ inputs.path_to_claude_code_executable }}")
|
||||||
|
echo "$CLAUDE_DIR" >> "$GITHUB_PATH"
|
||||||
|
fi
|
||||||
|
|
||||||
- name: Run Claude Code Action
|
- name: Run Claude Code Action
|
||||||
shell: bash
|
shell: bash
|
||||||
@@ -103,9 +123,9 @@ runs:
|
|||||||
INPUT_PROMPT: ${{ inputs.prompt }}
|
INPUT_PROMPT: ${{ inputs.prompt }}
|
||||||
INPUT_PROMPT_FILE: ${{ inputs.prompt_file }}
|
INPUT_PROMPT_FILE: ${{ inputs.prompt_file }}
|
||||||
INPUT_SETTINGS: ${{ inputs.settings }}
|
INPUT_SETTINGS: ${{ inputs.settings }}
|
||||||
INPUT_TIMEOUT_MINUTES: ${{ inputs.timeout_minutes }}
|
|
||||||
INPUT_CLAUDE_ARGS: ${{ inputs.claude_args }}
|
INPUT_CLAUDE_ARGS: ${{ inputs.claude_args }}
|
||||||
INPUT_EXPERIMENTAL_SLASH_COMMANDS_DIR: ${{ inputs.experimental_slash_commands_dir }}
|
INPUT_PATH_TO_CLAUDE_CODE_EXECUTABLE: ${{ inputs.path_to_claude_code_executable }}
|
||||||
|
INPUT_PATH_TO_BUN_EXECUTABLE: ${{ inputs.path_to_bun_executable }}
|
||||||
|
|
||||||
# Provider configuration
|
# Provider configuration
|
||||||
ANTHROPIC_API_KEY: ${{ inputs.anthropic_api_key }}
|
ANTHROPIC_API_KEY: ${{ inputs.anthropic_api_key }}
|
||||||
|
|||||||
@@ -103,6 +103,6 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
prompt_file: /tmp/claude-prompts/triage-prompt.txt
|
prompt_file: /tmp/claude-prompts/triage-prompt.txt
|
||||||
allowed_tools: "Bash(gh label list),mcp__github__get_issue,mcp__github__get_issue_comments,mcp__github__update_issue,mcp__github__search_issues,mcp__github__list_issues"
|
allowed_tools: "Bash(gh label list),mcp__github__get_issue,mcp__github__get_issue_comments,mcp__github__update_issue,mcp__github__search_issues,mcp__github__list_issues"
|
||||||
mcp_config: /tmp/mcp-config/mcp-servers.json
|
claude_args: |
|
||||||
timeout_minutes: "5"
|
--mcp-config /tmp/mcp-config/mcp-servers.json
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
|
|||||||
@@ -13,7 +13,6 @@ async function run() {
|
|||||||
await setupClaudeCodeSettings(
|
await setupClaudeCodeSettings(
|
||||||
process.env.INPUT_SETTINGS,
|
process.env.INPUT_SETTINGS,
|
||||||
undefined, // homeDir
|
undefined, // homeDir
|
||||||
process.env.INPUT_EXPERIMENTAL_SLASH_COMMANDS_DIR,
|
|
||||||
);
|
);
|
||||||
|
|
||||||
const promptConfig = await preparePrompt({
|
const promptConfig = await preparePrompt({
|
||||||
@@ -22,8 +21,18 @@ async function run() {
|
|||||||
});
|
});
|
||||||
|
|
||||||
await runClaude(promptConfig.path, {
|
await runClaude(promptConfig.path, {
|
||||||
timeoutMinutes: process.env.INPUT_TIMEOUT_MINUTES,
|
|
||||||
claudeArgs: process.env.INPUT_CLAUDE_ARGS,
|
claudeArgs: process.env.INPUT_CLAUDE_ARGS,
|
||||||
|
allowedTools: process.env.INPUT_ALLOWED_TOOLS,
|
||||||
|
disallowedTools: process.env.INPUT_DISALLOWED_TOOLS,
|
||||||
|
maxTurns: process.env.INPUT_MAX_TURNS,
|
||||||
|
mcpConfig: process.env.INPUT_MCP_CONFIG,
|
||||||
|
systemPrompt: process.env.INPUT_SYSTEM_PROMPT,
|
||||||
|
appendSystemPrompt: process.env.INPUT_APPEND_SYSTEM_PROMPT,
|
||||||
|
claudeEnv: process.env.INPUT_CLAUDE_ENV,
|
||||||
|
fallbackModel: process.env.INPUT_FALLBACK_MODEL,
|
||||||
|
model: process.env.ANTHROPIC_MODEL,
|
||||||
|
pathToClaudeCodeExecutable:
|
||||||
|
process.env.INPUT_PATH_TO_CLAUDE_CODE_EXECUTABLE,
|
||||||
});
|
});
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
core.setFailed(`Action failed with error: ${error}`);
|
core.setFailed(`Action failed with error: ${error}`);
|
||||||
|
|||||||
@@ -13,8 +13,17 @@ const EXECUTION_FILE = `${process.env.RUNNER_TEMP}/claude-execution-output.json`
|
|||||||
const BASE_ARGS = ["--verbose", "--output-format", "stream-json"];
|
const BASE_ARGS = ["--verbose", "--output-format", "stream-json"];
|
||||||
|
|
||||||
export type ClaudeOptions = {
|
export type ClaudeOptions = {
|
||||||
timeoutMinutes?: string;
|
|
||||||
claudeArgs?: string;
|
claudeArgs?: string;
|
||||||
|
model?: string;
|
||||||
|
pathToClaudeCodeExecutable?: string;
|
||||||
|
allowedTools?: string;
|
||||||
|
disallowedTools?: string;
|
||||||
|
maxTurns?: string;
|
||||||
|
mcpConfig?: string;
|
||||||
|
systemPrompt?: string;
|
||||||
|
appendSystemPrompt?: string;
|
||||||
|
claudeEnv?: string;
|
||||||
|
fallbackModel?: string;
|
||||||
};
|
};
|
||||||
|
|
||||||
type PreparedConfig = {
|
type PreparedConfig = {
|
||||||
@@ -46,16 +55,6 @@ export function prepareRunConfig(
|
|||||||
// BASE_ARGS are always appended last (cannot be overridden)
|
// BASE_ARGS are always appended last (cannot be overridden)
|
||||||
claudeArgs.push(...BASE_ARGS);
|
claudeArgs.push(...BASE_ARGS);
|
||||||
|
|
||||||
// Validate timeout if provided (affects process wrapper, not Claude)
|
|
||||||
if (options.timeoutMinutes) {
|
|
||||||
const timeoutMinutesNum = parseInt(options.timeoutMinutes, 10);
|
|
||||||
if (isNaN(timeoutMinutesNum) || timeoutMinutesNum <= 0) {
|
|
||||||
throw new Error(
|
|
||||||
`timeoutMinutes must be a positive number, got: ${options.timeoutMinutes}`,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
const customEnv: Record<string, string> = {};
|
const customEnv: Record<string, string> = {};
|
||||||
|
|
||||||
if (process.env.INPUT_ACTION_INPUTS_PRESENT) {
|
if (process.env.INPUT_ACTION_INPUTS_PRESENT) {
|
||||||
@@ -122,7 +121,10 @@ export async function runClaude(promptPath: string, options: ClaudeOptions) {
|
|||||||
pipeStream.destroy();
|
pipeStream.destroy();
|
||||||
});
|
});
|
||||||
|
|
||||||
const claudeProcess = spawn("claude", config.claudeArgs, {
|
// Use custom executable path if provided, otherwise default to "claude"
|
||||||
|
const claudeExecutable = options.pathToClaudeCodeExecutable || "claude";
|
||||||
|
|
||||||
|
const claudeProcess = spawn(claudeExecutable, config.claudeArgs, {
|
||||||
stdio: ["pipe", "pipe", "inherit"],
|
stdio: ["pipe", "pipe", "inherit"],
|
||||||
env: {
|
env: {
|
||||||
...process.env,
|
...process.env,
|
||||||
@@ -181,57 +183,15 @@ export async function runClaude(promptPath: string, options: ClaudeOptions) {
|
|||||||
claudeProcess.kill("SIGTERM");
|
claudeProcess.kill("SIGTERM");
|
||||||
});
|
});
|
||||||
|
|
||||||
// Wait for Claude to finish with timeout
|
// Wait for Claude to finish
|
||||||
let timeoutMs = 10 * 60 * 1000; // Default 10 minutes
|
|
||||||
if (options.timeoutMinutes) {
|
|
||||||
timeoutMs = parseInt(options.timeoutMinutes, 10) * 60 * 1000;
|
|
||||||
} else if (process.env.INPUT_TIMEOUT_MINUTES) {
|
|
||||||
const envTimeout = parseInt(process.env.INPUT_TIMEOUT_MINUTES, 10);
|
|
||||||
if (isNaN(envTimeout) || envTimeout <= 0) {
|
|
||||||
throw new Error(
|
|
||||||
`INPUT_TIMEOUT_MINUTES must be a positive number, got: ${process.env.INPUT_TIMEOUT_MINUTES}`,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
timeoutMs = envTimeout * 60 * 1000;
|
|
||||||
}
|
|
||||||
const exitCode = await new Promise<number>((resolve) => {
|
const exitCode = await new Promise<number>((resolve) => {
|
||||||
let resolved = false;
|
|
||||||
|
|
||||||
// Set a timeout for the process
|
|
||||||
const timeoutId = setTimeout(() => {
|
|
||||||
if (!resolved) {
|
|
||||||
console.error(
|
|
||||||
`Claude process timed out after ${timeoutMs / 1000} seconds`,
|
|
||||||
);
|
|
||||||
claudeProcess.kill("SIGTERM");
|
|
||||||
// Give it 5 seconds to terminate gracefully, then force kill
|
|
||||||
setTimeout(() => {
|
|
||||||
try {
|
|
||||||
claudeProcess.kill("SIGKILL");
|
|
||||||
} catch (e) {
|
|
||||||
// Process may already be dead
|
|
||||||
}
|
|
||||||
}, 5000);
|
|
||||||
resolved = true;
|
|
||||||
resolve(124); // Standard timeout exit code
|
|
||||||
}
|
|
||||||
}, timeoutMs);
|
|
||||||
|
|
||||||
claudeProcess.on("close", (code) => {
|
claudeProcess.on("close", (code) => {
|
||||||
if (!resolved) {
|
resolve(code || 0);
|
||||||
clearTimeout(timeoutId);
|
|
||||||
resolved = true;
|
|
||||||
resolve(code || 0);
|
|
||||||
}
|
|
||||||
});
|
});
|
||||||
|
|
||||||
claudeProcess.on("error", (error) => {
|
claudeProcess.on("error", (error) => {
|
||||||
if (!resolved) {
|
console.error("Claude process error:", error);
|
||||||
console.error("Claude process error:", error);
|
resolve(1);
|
||||||
clearTimeout(timeoutId);
|
|
||||||
resolved = true;
|
|
||||||
resolve(1);
|
|
||||||
}
|
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -261,7 +221,10 @@ export async function runClaude(promptPath: string, options: ClaudeOptions) {
|
|||||||
await writeFile("output.txt", output);
|
await writeFile("output.txt", output);
|
||||||
|
|
||||||
// Process output.txt into JSON and save to execution file
|
// Process output.txt into JSON and save to execution file
|
||||||
const { stdout: jsonOutput } = await execAsync("jq -s '.' output.txt");
|
// Increase maxBuffer from Node.js default of 1MB to 10MB to handle large Claude outputs
|
||||||
|
const { stdout: jsonOutput } = await execAsync("jq -s '.' output.txt", {
|
||||||
|
maxBuffer: 10 * 1024 * 1024,
|
||||||
|
});
|
||||||
await writeFile(EXECUTION_FILE, jsonOutput);
|
await writeFile(EXECUTION_FILE, jsonOutput);
|
||||||
|
|
||||||
console.log(`Log saved to ${EXECUTION_FILE}`);
|
console.log(`Log saved to ${EXECUTION_FILE}`);
|
||||||
@@ -278,7 +241,10 @@ export async function runClaude(promptPath: string, options: ClaudeOptions) {
|
|||||||
if (output) {
|
if (output) {
|
||||||
try {
|
try {
|
||||||
await writeFile("output.txt", output);
|
await writeFile("output.txt", output);
|
||||||
const { stdout: jsonOutput } = await execAsync("jq -s '.' output.txt");
|
// Increase maxBuffer from Node.js default of 1MB to 10MB to handle large Claude outputs
|
||||||
|
const { stdout: jsonOutput } = await execAsync("jq -s '.' output.txt", {
|
||||||
|
maxBuffer: 10 * 1024 * 1024,
|
||||||
|
});
|
||||||
await writeFile(EXECUTION_FILE, jsonOutput);
|
await writeFile(EXECUTION_FILE, jsonOutput);
|
||||||
core.setOutput("execution_file", EXECUTION_FILE);
|
core.setOutput("execution_file", EXECUTION_FILE);
|
||||||
} catch (e) {
|
} catch (e) {
|
||||||
|
|||||||
@@ -5,7 +5,6 @@ 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`;
|
||||||
@@ -66,40 +65,4 @@ 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}`);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Copy project subagents to Claude's agents directory
|
|
||||||
// Use GITHUB_WORKSPACE if available (set by GitHub Actions), otherwise use current directory
|
|
||||||
const workspaceDir = process.env.GITHUB_WORKSPACE || process.cwd();
|
|
||||||
const projectAgentsDir = `${workspaceDir}/.claude/agents`;
|
|
||||||
const claudeAgentsDir = `${home}/.claude/agents`;
|
|
||||||
|
|
||||||
try {
|
|
||||||
await $`test -d ${projectAgentsDir}`.quiet();
|
|
||||||
console.log(`Found project agents directory at ${projectAgentsDir}`);
|
|
||||||
|
|
||||||
await $`mkdir -p ${claudeAgentsDir}`.quiet();
|
|
||||||
|
|
||||||
await $`cp ${projectAgentsDir}/*.md ${claudeAgentsDir}/ 2>/dev/null || true`.quiet();
|
|
||||||
|
|
||||||
const agentFiles = await $`ls ${claudeAgentsDir}/*.md 2>/dev/null | wc -l`
|
|
||||||
.quiet()
|
|
||||||
.text();
|
|
||||||
const agentCount = parseInt(agentFiles.trim()) || 0;
|
|
||||||
console.log(`Copied ${agentCount} agent(s) to ${claudeAgentsDir}`);
|
|
||||||
} catch (e) {
|
|
||||||
console.log(`No project agents directory found at ${projectAgentsDir}`);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -30,36 +30,6 @@ describe("prepareRunConfig", () => {
|
|||||||
expect(prepared.promptPath).toBe("/custom/prompt/path.txt");
|
expect(prepared.promptPath).toBe("/custom/prompt/path.txt");
|
||||||
});
|
});
|
||||||
|
|
||||||
describe("timeoutMinutes validation", () => {
|
|
||||||
test("should accept valid timeoutMinutes value", () => {
|
|
||||||
const options: ClaudeOptions = { timeoutMinutes: "15" };
|
|
||||||
expect(() =>
|
|
||||||
prepareRunConfig("/tmp/test-prompt.txt", options),
|
|
||||||
).not.toThrow();
|
|
||||||
});
|
|
||||||
|
|
||||||
test("should throw error for non-numeric timeoutMinutes", () => {
|
|
||||||
const options: ClaudeOptions = { timeoutMinutes: "abc" };
|
|
||||||
expect(() => prepareRunConfig("/tmp/test-prompt.txt", options)).toThrow(
|
|
||||||
"timeoutMinutes must be a positive number, got: abc",
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("should throw error for negative timeoutMinutes", () => {
|
|
||||||
const options: ClaudeOptions = { timeoutMinutes: "-5" };
|
|
||||||
expect(() => prepareRunConfig("/tmp/test-prompt.txt", options)).toThrow(
|
|
||||||
"timeoutMinutes must be a positive number, got: -5",
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("should throw error for zero timeoutMinutes", () => {
|
|
||||||
const options: ClaudeOptions = { timeoutMinutes: "0" };
|
|
||||||
expect(() => prepareRunConfig("/tmp/test-prompt.txt", options)).toThrow(
|
|
||||||
"timeoutMinutes must be a positive number, got: 0",
|
|
||||||
);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe("claudeArgs handling", () => {
|
describe("claudeArgs handling", () => {
|
||||||
test("should parse and include custom claude arguments", () => {
|
test("should parse and include custom claude arguments", () => {
|
||||||
const options: ClaudeOptions = {
|
const options: ClaudeOptions = {
|
||||||
|
|||||||
@@ -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, readdir } from "fs/promises";
|
import { mkdir, writeFile, readFile, rm } from "fs/promises";
|
||||||
import { join } from "path";
|
import { join } from "path";
|
||||||
|
|
||||||
const testHomeDir = join(
|
const testHomeDir = join(
|
||||||
@@ -147,138 +147,4 @@ describe("setupClaudeCodeSettings", () => {
|
|||||||
expect(settings.newKey).toBe("newValue");
|
expect(settings.newKey).toBe("newValue");
|
||||||
expect(settings.model).toBe("claude-opus-4-1-20250805");
|
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);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("should copy project agents when .claude/agents directory exists", async () => {
|
|
||||||
// Create a mock project structure with agents
|
|
||||||
const projectDir = join(testHomeDir, "test-project");
|
|
||||||
const projectAgentsDir = join(projectDir, ".claude", "agents");
|
|
||||||
await mkdir(projectAgentsDir, { recursive: true });
|
|
||||||
|
|
||||||
// Create test agent files
|
|
||||||
await writeFile(
|
|
||||||
join(projectAgentsDir, "test-agent.md"),
|
|
||||||
"---\nname: test-agent\ndescription: Test agent\n---\nTest agent content",
|
|
||||||
);
|
|
||||||
await writeFile(
|
|
||||||
join(projectAgentsDir, "another-agent.md"),
|
|
||||||
"---\nname: another-agent\n---\nAnother agent",
|
|
||||||
);
|
|
||||||
|
|
||||||
// Set GITHUB_WORKSPACE to the test project directory
|
|
||||||
const originalWorkspace = process.env.GITHUB_WORKSPACE;
|
|
||||||
process.env.GITHUB_WORKSPACE = projectDir;
|
|
||||||
|
|
||||||
try {
|
|
||||||
await setupClaudeCodeSettings(undefined, testHomeDir);
|
|
||||||
|
|
||||||
// Check that agents were copied
|
|
||||||
const agentsDir = join(testHomeDir, ".claude", "agents");
|
|
||||||
const files = await readdir(agentsDir);
|
|
||||||
expect(files).toContain("test-agent.md");
|
|
||||||
expect(files).toContain("another-agent.md");
|
|
||||||
|
|
||||||
// Verify content was copied correctly
|
|
||||||
const content = await readFile(join(agentsDir, "test-agent.md"), "utf-8");
|
|
||||||
expect(content).toContain("Test agent content");
|
|
||||||
} finally {
|
|
||||||
// Restore original GITHUB_WORKSPACE
|
|
||||||
if (originalWorkspace !== undefined) {
|
|
||||||
process.env.GITHUB_WORKSPACE = originalWorkspace;
|
|
||||||
} else {
|
|
||||||
delete process.env.GITHUB_WORKSPACE;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
test("should handle missing project agents directory gracefully", async () => {
|
|
||||||
// Set GITHUB_WORKSPACE to a directory without .claude/agents
|
|
||||||
const projectDir = join(testHomeDir, "project-without-agents");
|
|
||||||
await mkdir(projectDir, { recursive: true });
|
|
||||||
|
|
||||||
const originalWorkspace = process.env.GITHUB_WORKSPACE;
|
|
||||||
process.env.GITHUB_WORKSPACE = projectDir;
|
|
||||||
|
|
||||||
try {
|
|
||||||
await setupClaudeCodeSettings(undefined, testHomeDir);
|
|
||||||
|
|
||||||
// Should complete without errors
|
|
||||||
const settingsContent = await readFile(settingsPath, "utf-8");
|
|
||||||
const settings = JSON.parse(settingsContent);
|
|
||||||
expect(settings.enableAllProjectMcpServers).toBe(true);
|
|
||||||
} finally {
|
|
||||||
if (originalWorkspace !== undefined) {
|
|
||||||
process.env.GITHUB_WORKSPACE = originalWorkspace;
|
|
||||||
} else {
|
|
||||||
delete process.env.GITHUB_WORKSPACE;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
});
|
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -20,23 +20,25 @@ Use provider-specific model names based on your chosen provider:
|
|||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# For direct Anthropic API (default)
|
# For direct Anthropic API (default)
|
||||||
- uses: anthropics/claude-code-action@beta
|
- uses: anthropics/claude-code-action@v1
|
||||||
with:
|
with:
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
# ... other inputs
|
# ... other inputs
|
||||||
|
|
||||||
# For Amazon Bedrock with OIDC
|
# For Amazon Bedrock with OIDC
|
||||||
- uses: anthropics/claude-code-action@beta
|
- uses: anthropics/claude-code-action@v1
|
||||||
with:
|
with:
|
||||||
model: "anthropic.claude-3-7-sonnet-20250219-beta:0" # Cross-region inference
|
|
||||||
use_bedrock: "true"
|
use_bedrock: "true"
|
||||||
|
claude_args: |
|
||||||
|
--model anthropic.claude-4-0-sonnet-20250805-v1:0
|
||||||
# ... other inputs
|
# ... other inputs
|
||||||
|
|
||||||
# For Google Vertex AI with OIDC
|
# For Google Vertex AI with OIDC
|
||||||
- uses: anthropics/claude-code-action@beta
|
- uses: anthropics/claude-code-action@v1
|
||||||
with:
|
with:
|
||||||
model: "claude-3-7-sonnet@20250219"
|
|
||||||
use_vertex: "true"
|
use_vertex: "true"
|
||||||
|
claude_args: |
|
||||||
|
--model claude-4-0-sonnet@20250805
|
||||||
# ... other inputs
|
# ... other inputs
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -59,10 +61,11 @@ Both AWS Bedrock and GCP Vertex AI require OIDC authentication.
|
|||||||
app-id: ${{ secrets.APP_ID }}
|
app-id: ${{ secrets.APP_ID }}
|
||||||
private-key: ${{ secrets.APP_PRIVATE_KEY }}
|
private-key: ${{ secrets.APP_PRIVATE_KEY }}
|
||||||
|
|
||||||
- uses: anthropics/claude-code-action@beta
|
- uses: anthropics/claude-code-action@v1
|
||||||
with:
|
with:
|
||||||
model: "anthropic.claude-3-7-sonnet-20250219-beta:0"
|
|
||||||
use_bedrock: "true"
|
use_bedrock: "true"
|
||||||
|
claude_args: |
|
||||||
|
--model anthropic.claude-4-0-sonnet-20250805-v1:0
|
||||||
# ... other inputs
|
# ... other inputs
|
||||||
|
|
||||||
permissions:
|
permissions:
|
||||||
@@ -84,10 +87,11 @@ Both AWS Bedrock and GCP Vertex AI require OIDC authentication.
|
|||||||
app-id: ${{ secrets.APP_ID }}
|
app-id: ${{ secrets.APP_ID }}
|
||||||
private-key: ${{ secrets.APP_PRIVATE_KEY }}
|
private-key: ${{ secrets.APP_PRIVATE_KEY }}
|
||||||
|
|
||||||
- uses: anthropics/claude-code-action@beta
|
- uses: anthropics/claude-code-action@v1
|
||||||
with:
|
with:
|
||||||
model: "claude-3-7-sonnet@20250219"
|
|
||||||
use_vertex: "true"
|
use_vertex: "true"
|
||||||
|
claude_args: |
|
||||||
|
--model claude-4-0-sonnet@20250805
|
||||||
# ... other inputs
|
# ... other inputs
|
||||||
|
|
||||||
permissions:
|
permissions:
|
||||||
|
|||||||
@@ -2,51 +2,47 @@
|
|||||||
|
|
||||||
## Using Custom MCP 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.
|
You can add custom MCP (Model Context Protocol) servers to extend Claude's capabilities using the `--mcp-config` flag in `claude_args`. These servers merge with the built-in GitHub MCP servers.
|
||||||
|
|
||||||
### Basic Example: Adding a Sequential Thinking Server
|
### Basic Example: Adding a Sequential Thinking Server
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: anthropics/claude-code-action@beta
|
- uses: anthropics/claude-code-action@v1
|
||||||
with:
|
with:
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
mcp_config: |
|
claude_args: |
|
||||||
{
|
--mcp-config '{"mcpServers": {"sequential-thinking": {"command": "npx", "args": ["-y", "@modelcontextprotocol/server-sequential-thinking"]}}}'
|
||||||
"mcpServers": {
|
--allowedTools mcp__sequential-thinking__sequentialthinking
|
||||||
"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
|
# ... other inputs
|
||||||
```
|
```
|
||||||
|
|
||||||
### Passing Secrets to MCP Servers
|
### Passing Secrets to MCP Servers
|
||||||
|
|
||||||
For MCP servers that require sensitive information like API keys or tokens, use GitHub Secrets in the environment variables:
|
For MCP servers that require sensitive information like API keys or tokens, you can create a configuration file with GitHub Secrets:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: anthropics/claude-code-action@beta
|
- name: Create MCP Config
|
||||||
with:
|
run: |
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
cat > /tmp/mcp-config.json << 'EOF'
|
||||||
mcp_config: |
|
{
|
||||||
{
|
"mcpServers": {
|
||||||
"mcpServers": {
|
"custom-api-server": {
|
||||||
"custom-api-server": {
|
"command": "npx",
|
||||||
"command": "npx",
|
"args": ["-y", "@example/api-server"],
|
||||||
"args": ["-y", "@example/api-server"],
|
"env": {
|
||||||
"env": {
|
"API_KEY": "${{ secrets.CUSTOM_API_KEY }}",
|
||||||
"API_KEY": "${{ secrets.CUSTOM_API_KEY }}",
|
"BASE_URL": "https://api.example.com"
|
||||||
"BASE_URL": "https://api.example.com"
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
EOF
|
||||||
|
|
||||||
|
- uses: anthropics/claude-code-action@v1
|
||||||
|
with:
|
||||||
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
|
claude_args: |
|
||||||
|
--mcp-config /tmp/mcp-config.json
|
||||||
# ... other inputs
|
# ... other inputs
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -55,25 +51,31 @@ For MCP servers that require sensitive information like API keys or tokens, use
|
|||||||
For Python-based MCP servers managed with `uv`, you need to specify the directory containing your server:
|
For Python-based MCP servers managed with `uv`, you need to specify the directory containing your server:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: anthropics/claude-code-action@beta
|
- name: Create MCP Config for Python Server
|
||||||
with:
|
run: |
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
cat > /tmp/mcp-config.json << 'EOF'
|
||||||
mcp_config: |
|
{
|
||||||
{
|
"mcpServers": {
|
||||||
"mcpServers": {
|
"my-python-server": {
|
||||||
"my-python-server": {
|
"type": "stdio",
|
||||||
"type": "stdio",
|
"command": "uv",
|
||||||
"command": "uv",
|
"args": [
|
||||||
"args": [
|
"--directory",
|
||||||
"--directory",
|
"${{ github.workspace }}/path/to/server/",
|
||||||
"${{ github.workspace }}/path/to/server/",
|
"run",
|
||||||
"run",
|
"server_file.py"
|
||||||
"server_file.py"
|
]
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
allowed_tools: "my-python-server__<tool_name>" # Replace <tool_name> with your server's tool names
|
}
|
||||||
|
EOF
|
||||||
|
|
||||||
|
- uses: anthropics/claude-code-action@v1
|
||||||
|
with:
|
||||||
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
|
claude_args: |
|
||||||
|
--mcp-config /tmp/mcp-config.json
|
||||||
|
--allowedTools my-python-server__<tool_name> # Replace <tool_name> with your server's tool names
|
||||||
# ... other inputs
|
# ... other inputs
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -84,10 +86,26 @@ For example, if your Python MCP server is at `mcp_servers/weather.py`, you would
|
|||||||
["--directory", "${{ github.workspace }}/mcp_servers/", "run", "weather.py"]
|
["--directory", "${{ github.workspace }}/mcp_servers/", "run", "weather.py"]
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Multiple MCP Servers
|
||||||
|
|
||||||
|
You can add multiple MCP servers by using multiple `--mcp-config` flags:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: anthropics/claude-code-action@v1
|
||||||
|
with:
|
||||||
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
|
claude_args: |
|
||||||
|
--mcp-config /tmp/config1.json
|
||||||
|
--mcp-config /tmp/config2.json
|
||||||
|
--mcp-config '{"mcpServers": {"inline-server": {"command": "npx", "args": ["@example/server"]}}}'
|
||||||
|
# ... other inputs
|
||||||
|
```
|
||||||
|
|
||||||
**Important**:
|
**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.
|
- 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.
|
- Your custom servers will override any built-in servers with the same name.
|
||||||
|
- The `claude_args` supports multiple `--mcp-config` flags that will be merged together.
|
||||||
|
|
||||||
## Additional Permissions for CI/CD Integration
|
## Additional Permissions for CI/CD Integration
|
||||||
|
|
||||||
@@ -160,33 +178,38 @@ jobs:
|
|||||||
|
|
||||||
## Custom Environment Variables
|
## 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:
|
You can pass custom environment variables to Claude Code execution using the `settings` input. This is useful for CI/test setups that require specific environment variables:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: anthropics/claude-code-action@beta
|
- uses: anthropics/claude-code-action@v1
|
||||||
with:
|
with:
|
||||||
claude_env: |
|
settings: |
|
||||||
NODE_ENV: test
|
{
|
||||||
CI: true
|
"env": {
|
||||||
DATABASE_URL: postgres://test:test@localhost:5432/test_db
|
"NODE_ENV": "test",
|
||||||
|
"CI": "true",
|
||||||
|
"DATABASE_URL": "postgres://test:test@localhost:5432/test_db"
|
||||||
|
}
|
||||||
|
}
|
||||||
# ... other inputs
|
# ... 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.
|
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
|
## 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:
|
You can limit the number of back-and-forth exchanges Claude can have during task execution using the `claude_args` input. This is useful for:
|
||||||
|
|
||||||
- Controlling costs by preventing runaway conversations
|
- Controlling costs by preventing runaway conversations
|
||||||
- Setting time boundaries for automated workflows
|
- Setting time boundaries for automated workflows
|
||||||
- Ensuring predictable behavior in CI/CD pipelines
|
- Ensuring predictable behavior in CI/CD pipelines
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: anthropics/claude-code-action@beta
|
- uses: anthropics/claude-code-action@v1
|
||||||
with:
|
with:
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
max_turns: "5" # Limit to 5 conversation turns
|
claude_args: |
|
||||||
|
--max-turns 5 # Limit to 5 conversation turns
|
||||||
# ... other inputs
|
# ... other inputs
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -200,28 +223,50 @@ By default, Claude only has access to:
|
|||||||
- Comment management (creating/updating comments)
|
- Comment management (creating/updating comments)
|
||||||
- Basic GitHub operations
|
- 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:
|
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 `claude_args` 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.
|
**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.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: anthropics/claude-code-action@beta
|
- uses: anthropics/claude-code-action@v1
|
||||||
with:
|
with:
|
||||||
allowed_tools: "Bash(npm install),Bash(npm run test),Edit,Replace,NotebookEditCell"
|
claude_args: |
|
||||||
disallowed_tools: "TaskOutput,KillTask"
|
--allowedTools "Bash(npm install),Bash(npm run test),Edit,Replace,NotebookEditCell"
|
||||||
|
--disallowedTools "TaskOutput,KillTask"
|
||||||
# ... other inputs
|
# ... 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.
|
**Note**: The base GitHub tools are always included. Use `--allowedTools` to add additional tools (including specific Bash commands), and `--disallowedTools` to prevent specific tools from being used.
|
||||||
|
|
||||||
## Custom Model
|
## Custom Model
|
||||||
|
|
||||||
Use a specific Claude model:
|
Specify a Claude model using `claude_args`:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: anthropics/claude-code-action@beta
|
- uses: anthropics/claude-code-action@v1
|
||||||
with:
|
with:
|
||||||
# model: "claude-3-5-sonnet-20241022" # Optional: specify a different model
|
claude_args: |
|
||||||
|
--model claude-4-0-sonnet-20250805
|
||||||
|
# ... other inputs
|
||||||
|
```
|
||||||
|
|
||||||
|
For provider-specific models:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# AWS Bedrock
|
||||||
|
- uses: anthropics/claude-code-action@v1
|
||||||
|
with:
|
||||||
|
use_bedrock: "true"
|
||||||
|
claude_args: |
|
||||||
|
--model anthropic.claude-4-0-sonnet-20250805-v1:0
|
||||||
|
# ... other inputs
|
||||||
|
|
||||||
|
# Google Vertex AI
|
||||||
|
- uses: anthropics/claude-code-action@v1
|
||||||
|
with:
|
||||||
|
use_vertex: "true"
|
||||||
|
claude_args: |
|
||||||
|
--model claude-4-0-sonnet@20250805
|
||||||
# ... other inputs
|
# ... other inputs
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -232,7 +277,7 @@ You can provide Claude Code settings to customize behavior such as model selecti
|
|||||||
### Option 1: Settings File
|
### Option 1: Settings File
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: anthropics/claude-code-action@beta
|
- uses: anthropics/claude-code-action@v1
|
||||||
with:
|
with:
|
||||||
settings: "path/to/settings.json"
|
settings: "path/to/settings.json"
|
||||||
# ... other inputs
|
# ... other inputs
|
||||||
@@ -241,7 +286,7 @@ You can provide Claude Code settings to customize behavior such as model selecti
|
|||||||
### Option 2: Inline Settings
|
### Option 2: Inline Settings
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: anthropics/claude-code-action@beta
|
- uses: anthropics/claude-code-action@v1
|
||||||
with:
|
with:
|
||||||
settings: |
|
settings: |
|
||||||
{
|
{
|
||||||
@@ -280,6 +325,21 @@ For a complete list of available settings and their descriptions, see the [Claud
|
|||||||
**Notes**:
|
**Notes**:
|
||||||
|
|
||||||
- The `enableAllProjectMcpServers` setting is always set to `true` by this action to ensure MCP servers work correctly.
|
- 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 `claude_args` input provides direct access to Claude Code CLI arguments and takes precedence over settings.
|
||||||
- The `allowed_tools` and `disallowed_tools` input parameters take precedence over `permissions` in settings.
|
- We recommend using `claude_args` for simple configurations and `settings` for complex configurations with hooks and environment variables.
|
||||||
- In a future version, we may deprecate individual input parameters in favor of using the settings file for all configuration.
|
|
||||||
|
## Migration from Deprecated Inputs
|
||||||
|
|
||||||
|
Many individual input parameters have been consolidated into `claude_args` or `settings`. Here's how to migrate:
|
||||||
|
|
||||||
|
| Old Input | New Approach |
|
||||||
|
| --------------------- | -------------------------------------------------------- |
|
||||||
|
| `allowed_tools` | Use `claude_args: "--allowedTools Tool1,Tool2"` |
|
||||||
|
| `disallowed_tools` | Use `claude_args: "--disallowedTools Tool1,Tool2"` |
|
||||||
|
| `max_turns` | Use `claude_args: "--max-turns 10"` |
|
||||||
|
| `model` | Use `claude_args: "--model claude-4-0-sonnet-20250805"` |
|
||||||
|
| `claude_env` | Use `settings` with `"env"` object |
|
||||||
|
| `custom_instructions` | Use `claude_args: "--system-prompt 'Your instructions'"` |
|
||||||
|
| `mcp_config` | Use `claude_args: "--mcp-config '{...}'"` |
|
||||||
|
| `direct_prompt` | Use `prompt` input instead |
|
||||||
|
| `override_prompt` | Use `prompt` with GitHub context variables |
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
# Custom Automations
|
# Custom Automations
|
||||||
|
|
||||||
These examples show how to configure Claude to act automatically based on GitHub events, without requiring manual @mentions.
|
These examples show how to configure Claude to act automatically based on GitHub events. When you provide a `prompt` input, the action automatically runs in agent mode without requiring manual @mentions. Without a `prompt`, it runs in interactive mode, responding to @claude mentions.
|
||||||
|
|
||||||
## Supported GitHub Events
|
## Supported GitHub Events
|
||||||
|
|
||||||
@@ -26,14 +26,15 @@ on:
|
|||||||
- "src/api/**/*.ts"
|
- "src/api/**/*.ts"
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: anthropics/claude-code-action@beta
|
- uses: anthropics/claude-code-action@v1
|
||||||
with:
|
with:
|
||||||
direct_prompt: |
|
prompt: |
|
||||||
Update the API documentation in README.md to reflect
|
Update the API documentation in README.md to reflect
|
||||||
the changes made to the API endpoints in this PR.
|
the changes made to the API endpoints in this PR.
|
||||||
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
```
|
```
|
||||||
|
|
||||||
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.
|
When API files are modified, the action automatically detects that a `prompt` is provided and runs in agent mode. Claude 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
|
## Author-Specific Code Reviews
|
||||||
|
|
||||||
@@ -50,28 +51,26 @@ jobs:
|
|||||||
github.event.pull_request.user.login == 'developer1' ||
|
github.event.pull_request.user.login == 'developer1' ||
|
||||||
github.event.pull_request.user.login == 'external-contributor'
|
github.event.pull_request.user.login == 'external-contributor'
|
||||||
steps:
|
steps:
|
||||||
- uses: anthropics/claude-code-action@beta
|
- uses: anthropics/claude-code-action@v1
|
||||||
with:
|
with:
|
||||||
direct_prompt: |
|
prompt: |
|
||||||
Please provide a thorough review of this pull request.
|
Please provide a thorough review of this pull request.
|
||||||
Pay extra attention to coding standards, security practices,
|
Pay extra attention to coding standards, security practices,
|
||||||
and test coverage since this is from an external contributor.
|
and test coverage since this is from an external contributor.
|
||||||
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
```
|
```
|
||||||
|
|
||||||
Perfect for automatically reviewing PRs from new team members, external contributors, or specific developers who need extra guidance.
|
Perfect for automatically reviewing PRs from new team members, external contributors, or specific developers who need extra guidance. The action automatically runs in agent mode when a `prompt` is provided.
|
||||||
|
|
||||||
## Custom Prompt Templates
|
## Custom Prompt Templates
|
||||||
|
|
||||||
Use `override_prompt` for complete control over Claude's behavior with variable substitution:
|
Use the `prompt` input with GitHub context variables for dynamic automation:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: anthropics/claude-code-action@beta
|
- uses: anthropics/claude-code-action@v1
|
||||||
with:
|
with:
|
||||||
override_prompt: |
|
prompt: |
|
||||||
Analyze PR #$PR_NUMBER in $REPOSITORY for security vulnerabilities.
|
Analyze PR #${{ github.event.pull_request.number }} in ${{ github.repository }} for security vulnerabilities.
|
||||||
|
|
||||||
Changed files:
|
|
||||||
$CHANGED_FILES
|
|
||||||
|
|
||||||
Focus on:
|
Focus on:
|
||||||
- SQL injection risks
|
- SQL injection risks
|
||||||
@@ -80,12 +79,35 @@ Use `override_prompt` for complete control over Claude's behavior with variable
|
|||||||
- Exposed secrets or credentials
|
- Exposed secrets or credentials
|
||||||
|
|
||||||
Provide severity ratings (Critical/High/Medium/Low) for any issues found.
|
Provide severity ratings (Critical/High/Medium/Low) for any issues found.
|
||||||
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
```
|
```
|
||||||
|
|
||||||
The `override_prompt` feature supports these variables:
|
You can access any GitHub context variable using the standard GitHub Actions syntax:
|
||||||
|
|
||||||
- `$REPOSITORY`, `$PR_NUMBER`, `$ISSUE_NUMBER`
|
- `${{ github.repository }}` - The repository name
|
||||||
- `$PR_TITLE`, `$ISSUE_TITLE`, `$PR_BODY`, `$ISSUE_BODY`
|
- `${{ github.event.pull_request.number }}` - PR number
|
||||||
- `$PR_COMMENTS`, `$ISSUE_COMMENTS`, `$REVIEW_COMMENTS`
|
- `${{ github.event.issue.number }}` - Issue number
|
||||||
- `$CHANGED_FILES`, `$TRIGGER_COMMENT`, `$TRIGGER_USERNAME`
|
- `${{ github.event.pull_request.title }}` - PR title
|
||||||
- `$BRANCH_NAME`, `$BASE_BRANCH`, `$EVENT_TYPE`, `$IS_PR`
|
- `${{ github.event.pull_request.body }}` - PR description
|
||||||
|
- `${{ github.event.comment.body }}` - Comment text
|
||||||
|
- `${{ github.actor }}` - User who triggered the workflow
|
||||||
|
- `${{ github.base_ref }}` - Base branch for PRs
|
||||||
|
- `${{ github.head_ref }}` - Head branch for PRs
|
||||||
|
|
||||||
|
## Advanced Configuration with claude_args
|
||||||
|
|
||||||
|
For more control over Claude's behavior, use the `claude_args` input to pass CLI arguments directly:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: anthropics/claude-code-action@v1
|
||||||
|
with:
|
||||||
|
prompt: "Review this PR for performance issues"
|
||||||
|
claude_args: |
|
||||||
|
--max-turns 15
|
||||||
|
--model claude-4-0-sonnet-20250805
|
||||||
|
--allowedTools Edit,Read,Write,Bash
|
||||||
|
--system-prompt "You are a performance optimization expert. Focus on identifying bottlenecks and suggesting improvements."
|
||||||
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
|
```
|
||||||
|
|
||||||
|
This provides full access to Claude Code CLI capabilities while maintaining the simplified action interface.
|
||||||
|
|||||||
@@ -2,65 +2,66 @@
|
|||||||
|
|
||||||
**Note:** Experimental features are considered unstable and not supported for production use. They may change or be removed at any time.
|
**Note:** Experimental features are considered unstable and not supported for production use. They may change or be removed at any time.
|
||||||
|
|
||||||
## Execution Modes
|
## Automatic Mode Detection
|
||||||
|
|
||||||
The action supports three execution modes, each optimized for different use cases:
|
The action intelligently detects the appropriate execution mode based on your workflow context, eliminating the need for manual mode configuration.
|
||||||
|
|
||||||
### Tag Mode (Default)
|
### Interactive Mode (Tag Mode)
|
||||||
|
|
||||||
The traditional implementation mode that responds to @claude mentions, issue assignments, or labels.
|
Activated when Claude detects @mentions, issue assignments, or labels—without an explicit `prompt`.
|
||||||
|
|
||||||
- **Triggers**: `@claude` mentions, issue assignment, label application
|
- **Triggers**: `@claude` mentions in comments, issue assignment to claude user, label application
|
||||||
- **Features**: Creates tracking comments with progress checkboxes, full implementation capabilities
|
- **Features**: Creates tracking comments with progress checkboxes, full implementation capabilities
|
||||||
- **Use case**: General-purpose code implementation and Q&A
|
- **Use case**: Interactive code assistance, Q&A, and implementation requests
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: anthropics/claude-code-action@beta
|
- uses: anthropics/claude-code-action@v1
|
||||||
with:
|
with:
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
# mode: tag is the default
|
# No prompt needed - responds to @claude mentions
|
||||||
```
|
```
|
||||||
|
|
||||||
### Agent Mode
|
### Automation Mode (Agent Mode)
|
||||||
|
|
||||||
**Note: Agent mode is currently in active development and may undergo breaking changes.**
|
Automatically activated when you provide a `prompt` input.
|
||||||
|
|
||||||
For direct automation when an explicit prompt is provided.
|
- **Triggers**: Any GitHub event when `prompt` input is provided
|
||||||
|
- **Features**: Direct execution without requiring @claude mentions, streamlined for automation
|
||||||
- **Triggers**: Works with any event when `prompt` input is provided
|
|
||||||
- **Features**: Direct execution without @claude mentions, no tracking comments
|
|
||||||
- **Use case**: Automated PR reviews, scheduled tasks, workflow automation
|
- **Use case**: Automated PR reviews, scheduled tasks, workflow automation
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: anthropics/claude-code-action@beta
|
- uses: anthropics/claude-code-action@v1
|
||||||
with:
|
with:
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
prompt: |
|
prompt: |
|
||||||
Check for outdated dependencies and create an issue if any are found.
|
Check for outdated dependencies and create an issue if any are found.
|
||||||
# Mode is auto-detected when prompt is provided
|
# Automatically runs in agent mode when prompt is provided
|
||||||
```
|
```
|
||||||
|
|
||||||
### Experimental Review Mode
|
### How It Works
|
||||||
|
|
||||||
**Warning: This is an experimental feature that may change or be removed at any time.**
|
The action uses this logic to determine the mode:
|
||||||
|
|
||||||
For automated code reviews on pull requests.
|
1. **If `prompt` is provided** → Runs in **agent mode** for automation
|
||||||
|
2. **If no `prompt` but @claude is mentioned** → Runs in **tag mode** for interaction
|
||||||
|
3. **If neither** → No action is taken
|
||||||
|
|
||||||
- **Triggers**: Pull request events (`opened`, `synchronize`) or `@claude review` comments
|
This automatic detection ensures your workflows are simpler and more intuitive, without needing to understand or configure different modes.
|
||||||
- **Features**: Provides detailed code reviews with inline comments and suggestions
|
|
||||||
- **Use case**: Automated PR reviews, code quality checks
|
### Advanced Mode Control
|
||||||
|
|
||||||
|
For specialized use cases, you can fine-tune behavior using `claude_args`:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: anthropics/claude-code-action@beta
|
- uses: anthropics/claude-code-action@v1
|
||||||
with:
|
with:
|
||||||
mode: experimental-review
|
prompt: "Review this PR"
|
||||||
|
claude_args: |
|
||||||
|
--max-turns 20
|
||||||
|
--system-prompt "You are a code review specialist"
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
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
|
## Network Restrictions
|
||||||
|
|
||||||
For enhanced security, you can restrict Claude's network access to specific domains only. This feature is particularly useful for:
|
For enhanced security, you can restrict Claude's network access to specific domains only. This feature is particularly useful for:
|
||||||
@@ -76,7 +77,7 @@ When `experimental_allowed_domains` is set, Claude can only access the domains y
|
|||||||
#### If using Anthropic API or subscription
|
#### If using Anthropic API or subscription
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: anthropics/claude-code-action@beta
|
- uses: anthropics/claude-code-action@v1
|
||||||
with:
|
with:
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
# Or: claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
|
# Or: claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
|
||||||
@@ -87,7 +88,7 @@ When `experimental_allowed_domains` is set, Claude can only access the domains y
|
|||||||
#### If using AWS Bedrock
|
#### If using AWS Bedrock
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: anthropics/claude-code-action@beta
|
- uses: anthropics/claude-code-action@v1
|
||||||
with:
|
with:
|
||||||
use_bedrock: "true"
|
use_bedrock: "true"
|
||||||
experimental_allowed_domains: |
|
experimental_allowed_domains: |
|
||||||
@@ -98,7 +99,7 @@ When `experimental_allowed_domains` is set, Claude can only access the domains y
|
|||||||
#### If using Google Vertex AI
|
#### If using Google Vertex AI
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: anthropics/claude-code-action@beta
|
- uses: anthropics/claude-code-action@v1
|
||||||
with:
|
with:
|
||||||
use_vertex: "true"
|
use_vertex: "true"
|
||||||
experimental_allowed_domains: |
|
experimental_allowed_domains: |
|
||||||
@@ -111,7 +112,7 @@ When `experimental_allowed_domains` is set, Claude can only access the domains y
|
|||||||
In addition to your provider domains, you may need to include GitHub-related domains. For GitHub.com users, common domains include:
|
In addition to your provider domains, you may need to include GitHub-related domains. For GitHub.com users, common domains include:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: anthropics/claude-code-action@beta
|
- uses: anthropics/claude-code-action@v1
|
||||||
with:
|
with:
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
experimental_allowed_domains: |
|
experimental_allowed_domains: |
|
||||||
|
|||||||
52
docs/faq.md
52
docs/faq.md
@@ -41,10 +41,11 @@ By default, Claude only uses commit tools for non-destructive changes to the bra
|
|||||||
- Never push to branches other than where it was invoked (either its own branch or the PR branch)
|
- Never push to branches other than where it was invoked (either its own branch or the PR branch)
|
||||||
- Never force push or perform destructive operations
|
- Never force push or perform destructive operations
|
||||||
|
|
||||||
You can grant additional tools via the `allowed_tools` input if needed:
|
You can grant additional tools via the `claude_args` input if needed:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
allowed_tools: "Bash(git rebase:*)" # Use with caution
|
claude_args: |
|
||||||
|
--allowedTools "Bash(git rebase:*)" # Use with caution
|
||||||
```
|
```
|
||||||
|
|
||||||
### Why won't Claude create a pull request?
|
### Why won't Claude create a pull request?
|
||||||
@@ -67,7 +68,7 @@ Yes! Claude can access GitHub Actions workflow runs, job logs, and test results
|
|||||||
|
|
||||||
2. Configure the action with additional permissions:
|
2. Configure the action with additional permissions:
|
||||||
```yaml
|
```yaml
|
||||||
- uses: anthropics/claude-code-action@beta
|
- uses: anthropics/claude-code-action@v1
|
||||||
with:
|
with:
|
||||||
additional_permissions: |
|
additional_permissions: |
|
||||||
actions: read
|
actions: read
|
||||||
@@ -105,30 +106,51 @@ If you need full history, you can configure this in your workflow before calling
|
|||||||
|
|
||||||
## Configuration and Tools
|
## Configuration and Tools
|
||||||
|
|
||||||
### What's the difference between `direct_prompt` and `custom_instructions`?
|
### How does automatic mode detection work?
|
||||||
|
|
||||||
These inputs serve different purposes in how Claude responds:
|
The action intelligently detects whether to run in interactive mode or automation mode:
|
||||||
|
|
||||||
- **`direct_prompt`**: Bypasses trigger detection entirely. When provided, Claude executes this exact instruction regardless of comments or mentions. Perfect for automated workflows where you want Claude to perform a specific task on every run (e.g., "Update the API documentation based on changes in this PR").
|
- **With `prompt` input**: Runs in automation mode - executes immediately without waiting for @claude mentions
|
||||||
|
- **Without `prompt` input**: Runs in interactive mode - waits for @claude mentions in comments
|
||||||
|
|
||||||
- **`custom_instructions`**: Additional context added to Claude's system prompt while still respecting normal triggers. These instructions modify Claude's behavior but don't replace the triggering comment. Use this to give Claude standing instructions like "You have been granted additional tools for ...".
|
This automatic detection eliminates the need to manually configure modes.
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Using direct_prompt - runs automatically without @claude mention
|
# Automation mode - runs automatically
|
||||||
direct_prompt: "Review this PR for security vulnerabilities"
|
prompt: "Review this PR for security vulnerabilities"
|
||||||
|
# Interactive mode - waits for @claude mention
|
||||||
|
# (no prompt provided)
|
||||||
|
```
|
||||||
|
|
||||||
# Using custom_instructions - still requires @claude trigger
|
### What happened to `direct_prompt` and `custom_instructions`?
|
||||||
custom_instructions: "Focus on performance implications and suggest optimizations"
|
|
||||||
|
**These inputs are deprecated in v1.0:**
|
||||||
|
|
||||||
|
- **`direct_prompt`** → Use `prompt` instead
|
||||||
|
- **`custom_instructions`** → Use `claude_args` with `--system-prompt`
|
||||||
|
|
||||||
|
Migration examples:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# Old (v0.x)
|
||||||
|
direct_prompt: "Review this PR"
|
||||||
|
custom_instructions: "Focus on security"
|
||||||
|
|
||||||
|
# New (v1.0)
|
||||||
|
prompt: "Review this PR"
|
||||||
|
claude_args: |
|
||||||
|
--system-prompt "Focus on security"
|
||||||
```
|
```
|
||||||
|
|
||||||
### Why doesn't Claude execute my bash commands?
|
### Why doesn't Claude execute my bash commands?
|
||||||
|
|
||||||
The Bash tool is **disabled by default** for security. To enable individual bash commands:
|
The Bash tool is **disabled by default** for security. To enable individual bash commands using `claude_args`:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
allowed_tools: "Bash(npm:*),Bash(git:*)" # Allows only npm and git commands
|
claude_args: |
|
||||||
|
--allowedTools "Bash(npm:*),Bash(git:*)" # Allows only npm and git commands
|
||||||
```
|
```
|
||||||
|
|
||||||
### Can Claude work across multiple repositories?
|
### Can Claude work across multiple repositories?
|
||||||
@@ -152,7 +174,7 @@ Claude Code Action automatically configures two MCP servers:
|
|||||||
1. **GitHub MCP server**: For GitHub API operations
|
1. **GitHub MCP server**: For GitHub API operations
|
||||||
2. **File operations server**: For advanced file manipulation
|
2. **File operations server**: For advanced file manipulation
|
||||||
|
|
||||||
However, tools from these servers still need to be explicitly allowed via `allowed_tools`.
|
However, tools from these servers still need to be explicitly allowed via `claude_args` with `--allowedTools`.
|
||||||
|
|
||||||
## Troubleshooting
|
## Troubleshooting
|
||||||
|
|
||||||
@@ -168,7 +190,7 @@ The trigger uses word boundaries, so `@claude` must be a complete word. Variatio
|
|||||||
|
|
||||||
1. **Always specify permissions explicitly** in your workflow file
|
1. **Always specify permissions explicitly** in your workflow file
|
||||||
2. **Use GitHub Secrets** for API keys - never hardcode them
|
2. **Use GitHub Secrets** for API keys - never hardcode them
|
||||||
3. **Be specific with `allowed_tools`** - only enable what's necessary
|
3. **Be specific with tool permissions** - only enable what's necessary via `claude_args`
|
||||||
4. **Test in a separate branch** before using on important PRs
|
4. **Test in a separate branch** before using on important PRs
|
||||||
5. **Monitor Claude's token usage** to avoid hitting API limits
|
5. **Monitor Claude's token usage** to avoid hitting API limits
|
||||||
6. **Review Claude's changes** carefully before merging
|
6. **Review Claude's changes** carefully before merging
|
||||||
|
|||||||
261
docs/migration-guide.md
Normal file
261
docs/migration-guide.md
Normal file
@@ -0,0 +1,261 @@
|
|||||||
|
# Migration Guide: v0.x to v1.0
|
||||||
|
|
||||||
|
This guide helps you migrate from Claude Code Action v0.x to v1.0. The new version introduces intelligent mode detection and simplified configuration while maintaining backward compatibility for most use cases.
|
||||||
|
|
||||||
|
## Overview of Changes
|
||||||
|
|
||||||
|
### 🎯 Key Improvements in v1.0
|
||||||
|
|
||||||
|
1. **Automatic Mode Detection** - No more manual `mode` configuration
|
||||||
|
2. **Simplified Configuration** - Unified `prompt` and `claude_args` inputs
|
||||||
|
3. **Better SDK Alignment** - Closer integration with Claude Code CLI
|
||||||
|
|
||||||
|
### ⚠️ Breaking Changes
|
||||||
|
|
||||||
|
The following inputs have been deprecated and replaced:
|
||||||
|
|
||||||
|
| Deprecated Input | Replacement | Notes |
|
||||||
|
| --------------------- | -------------------------------- | --------------------------------------------- |
|
||||||
|
| `mode` | Auto-detected | Action automatically chooses based on context |
|
||||||
|
| `direct_prompt` | `prompt` | Direct drop-in replacement |
|
||||||
|
| `override_prompt` | `prompt` | Use GitHub context variables instead |
|
||||||
|
| `custom_instructions` | `claude_args: --system-prompt` | Move to CLI arguments |
|
||||||
|
| `max_turns` | `claude_args: --max-turns` | Use CLI format |
|
||||||
|
| `model` | `claude_args: --model` | Specify via CLI |
|
||||||
|
| `allowed_tools` | `claude_args: --allowedTools` | Use CLI format |
|
||||||
|
| `disallowed_tools` | `claude_args: --disallowedTools` | Use CLI format |
|
||||||
|
| `claude_env` | `settings` with env object | Use settings JSON |
|
||||||
|
| `mcp_config` | `claude_args: --mcp-config` | Pass MCP config via CLI arguments |
|
||||||
|
|
||||||
|
## Migration Examples
|
||||||
|
|
||||||
|
### Basic Interactive Workflow (@claude mentions)
|
||||||
|
|
||||||
|
**Before (v0.x):**
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: anthropics/claude-code-action@beta
|
||||||
|
with:
|
||||||
|
mode: "tag"
|
||||||
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
|
custom_instructions: "Follow our coding standards"
|
||||||
|
max_turns: "10"
|
||||||
|
allowed_tools: "Edit,Read,Write"
|
||||||
|
```
|
||||||
|
|
||||||
|
**After (v1.0):**
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: anthropics/claude-code-action@v1
|
||||||
|
with:
|
||||||
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
|
claude_args: |
|
||||||
|
--max-turns 10
|
||||||
|
--system-prompt "Follow our coding standards"
|
||||||
|
--allowedTools Edit,Read,Write
|
||||||
|
```
|
||||||
|
|
||||||
|
### Automation Workflow
|
||||||
|
|
||||||
|
**Before (v0.x):**
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: anthropics/claude-code-action@beta
|
||||||
|
with:
|
||||||
|
mode: "agent"
|
||||||
|
direct_prompt: "Review this PR for security issues"
|
||||||
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
|
model: "claude-3-5-sonnet-20241022"
|
||||||
|
allowed_tools: "Edit,Read,Write"
|
||||||
|
```
|
||||||
|
|
||||||
|
**After (v1.0):**
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: anthropics/claude-code-action@v1
|
||||||
|
with:
|
||||||
|
prompt: "Review this PR for security issues"
|
||||||
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
|
claude_args: |
|
||||||
|
--model claude-4-0-sonnet-20250805
|
||||||
|
--allowedTools Edit,Read,Write
|
||||||
|
```
|
||||||
|
|
||||||
|
### Custom Template with Variables
|
||||||
|
|
||||||
|
**Before (v0.x):**
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: anthropics/claude-code-action@beta
|
||||||
|
with:
|
||||||
|
override_prompt: |
|
||||||
|
Analyze PR #$PR_NUMBER in $REPOSITORY
|
||||||
|
Changed files: $CHANGED_FILES
|
||||||
|
Focus on security vulnerabilities
|
||||||
|
```
|
||||||
|
|
||||||
|
**After (v1.0):**
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: anthropics/claude-code-action@v1
|
||||||
|
with:
|
||||||
|
prompt: |
|
||||||
|
Analyze PR #${{ github.event.pull_request.number }} in ${{ github.repository }}
|
||||||
|
Focus on security vulnerabilities in the changed files
|
||||||
|
```
|
||||||
|
|
||||||
|
### Environment Variables
|
||||||
|
|
||||||
|
**Before (v0.x):**
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: anthropics/claude-code-action@beta
|
||||||
|
with:
|
||||||
|
claude_env: |
|
||||||
|
NODE_ENV: test
|
||||||
|
CI: true
|
||||||
|
```
|
||||||
|
|
||||||
|
**After (v1.0):**
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: anthropics/claude-code-action@v1
|
||||||
|
with:
|
||||||
|
settings: |
|
||||||
|
{
|
||||||
|
"env": {
|
||||||
|
"NODE_ENV": "test",
|
||||||
|
"CI": "true"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## How Mode Detection Works
|
||||||
|
|
||||||
|
The action now automatically detects the appropriate mode:
|
||||||
|
|
||||||
|
1. **If `prompt` is provided** → Runs in **automation mode**
|
||||||
|
|
||||||
|
- Executes immediately without waiting for @claude mentions
|
||||||
|
- Perfect for scheduled tasks, PR automation, etc.
|
||||||
|
|
||||||
|
2. **If no `prompt` but @claude is mentioned** → Runs in **interactive mode**
|
||||||
|
|
||||||
|
- Waits for and responds to @claude mentions
|
||||||
|
- Creates tracking comments with progress
|
||||||
|
|
||||||
|
3. **If neither** → No action is taken
|
||||||
|
|
||||||
|
## Advanced Configuration with claude_args
|
||||||
|
|
||||||
|
The `claude_args` input provides direct access to Claude Code CLI arguments:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
claude_args: |
|
||||||
|
--max-turns 15
|
||||||
|
--model claude-4-0-sonnet-20250805
|
||||||
|
--allowedTools Edit,Read,Write,Bash
|
||||||
|
--disallowedTools WebSearch
|
||||||
|
--system-prompt "You are a senior engineer focused on code quality"
|
||||||
|
--mcp-config '{"mcpServers": {"custom": {"command": "npx", "args": ["-y", "@example/server"]}}}'
|
||||||
|
```
|
||||||
|
|
||||||
|
### Common claude_args Options
|
||||||
|
|
||||||
|
| Option | Description | Example |
|
||||||
|
| ------------------- | ------------------------ | -------------------------------------- |
|
||||||
|
| `--max-turns` | Limit conversation turns | `--max-turns 10` |
|
||||||
|
| `--model` | Specify Claude model | `--model claude-4-0-sonnet-20250805` |
|
||||||
|
| `--allowedTools` | Enable specific tools | `--allowedTools Edit,Read,Write` |
|
||||||
|
| `--disallowedTools` | Disable specific tools | `--disallowedTools WebSearch` |
|
||||||
|
| `--system-prompt` | Add system instructions | `--system-prompt "Focus on security"` |
|
||||||
|
| `--mcp-config` | Add MCP server config | `--mcp-config '{"mcpServers": {...}}'` |
|
||||||
|
|
||||||
|
## Provider-Specific Updates
|
||||||
|
|
||||||
|
### AWS Bedrock
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: anthropics/claude-code-action@v1
|
||||||
|
with:
|
||||||
|
use_bedrock: "true"
|
||||||
|
claude_args: |
|
||||||
|
--model anthropic.claude-4-0-sonnet-20250805-v1:0
|
||||||
|
```
|
||||||
|
|
||||||
|
### Google Vertex AI
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: anthropics/claude-code-action@v1
|
||||||
|
with:
|
||||||
|
use_vertex: "true"
|
||||||
|
claude_args: |
|
||||||
|
--model claude-4-0-sonnet@20250805
|
||||||
|
```
|
||||||
|
|
||||||
|
## MCP Configuration Migration
|
||||||
|
|
||||||
|
### Adding Custom MCP Servers
|
||||||
|
|
||||||
|
**Before (v0.x):**
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: anthropics/claude-code-action@beta
|
||||||
|
with:
|
||||||
|
mcp_config: |
|
||||||
|
{
|
||||||
|
"mcpServers": {
|
||||||
|
"custom-server": {
|
||||||
|
"command": "npx",
|
||||||
|
"args": ["-y", "@example/server"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**After (v1.0):**
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: anthropics/claude-code-action@v1
|
||||||
|
with:
|
||||||
|
claude_args: |
|
||||||
|
--mcp-config '{"mcpServers": {"custom-server": {"command": "npx", "args": ["-y", "@example/server"]}}}'
|
||||||
|
```
|
||||||
|
|
||||||
|
You can also pass MCP configuration from a file:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: anthropics/claude-code-action@v1
|
||||||
|
with:
|
||||||
|
claude_args: |
|
||||||
|
--mcp-config /path/to/mcp-config.json
|
||||||
|
```
|
||||||
|
|
||||||
|
## Step-by-Step Migration Checklist
|
||||||
|
|
||||||
|
- [ ] Update action version from `@beta` to `@v1`
|
||||||
|
- [ ] Remove `mode` input (auto-detected now)
|
||||||
|
- [ ] Replace `direct_prompt` with `prompt`
|
||||||
|
- [ ] Replace `override_prompt` with `prompt` using GitHub context
|
||||||
|
- [ ] Move `custom_instructions` to `claude_args` with `--system-prompt`
|
||||||
|
- [ ] Convert `max_turns` to `claude_args` with `--max-turns`
|
||||||
|
- [ ] Convert `model` to `claude_args` with `--model`
|
||||||
|
- [ ] Convert `allowed_tools` to `claude_args` with `--allowedTools`
|
||||||
|
- [ ] Convert `disallowed_tools` to `claude_args` with `--disallowedTools`
|
||||||
|
- [ ] Move `claude_env` to `settings` JSON format
|
||||||
|
- [ ] Move `mcp_config` to `claude_args` with `--mcp-config`
|
||||||
|
- [ ] Test workflow in a non-production environment
|
||||||
|
|
||||||
|
## Getting Help
|
||||||
|
|
||||||
|
If you encounter issues during migration:
|
||||||
|
|
||||||
|
1. Check the [FAQ](./faq.md) for common questions
|
||||||
|
2. Review [example workflows](../examples/) for reference
|
||||||
|
3. Open an [issue](https://github.com/anthropics/claude-code-action/issues) for support
|
||||||
|
|
||||||
|
## Version Compatibility
|
||||||
|
|
||||||
|
- **v0.x workflows** will continue to work but with deprecation warnings
|
||||||
|
- **v1.0** is the recommended version for all new workflows
|
||||||
|
- Future versions may remove deprecated inputs entirely
|
||||||
168
docs/usage.md
168
docs/usage.md
@@ -18,27 +18,26 @@ jobs:
|
|||||||
claude-response:
|
claude-response:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: anthropics/claude-code-action@beta
|
- uses: anthropics/claude-code-action@v1
|
||||||
with:
|
with:
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
# Or use OAuth token instead:
|
# Or use OAuth token instead:
|
||||||
# claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
|
# claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
|
||||||
github_token: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
# Optional: set execution mode (default: tag)
|
# Optional: provide a prompt for automation workflows
|
||||||
# mode: "tag"
|
# prompt: "Review this PR for security issues"
|
||||||
|
|
||||||
|
# Optional: pass advanced arguments to Claude CLI
|
||||||
|
# claude_args: |
|
||||||
|
# --max-turns 10
|
||||||
|
# --model claude-4-0-sonnet-20250805
|
||||||
|
|
||||||
# Optional: add custom trigger phrase (default: @claude)
|
# Optional: add custom trigger phrase (default: @claude)
|
||||||
# trigger_phrase: "/claude"
|
# trigger_phrase: "/claude"
|
||||||
# Optional: add assignee trigger for issues
|
# Optional: add assignee trigger for issues
|
||||||
# assignee_trigger: "claude"
|
# assignee_trigger: "claude"
|
||||||
# Optional: add label trigger for issues
|
# Optional: add label trigger for issues
|
||||||
# label_trigger: "claude"
|
# 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)
|
# Optional: grant additional permissions (requires corresponding GitHub token permissions)
|
||||||
# additional_permissions: |
|
# additional_permissions: |
|
||||||
# actions: read
|
# actions: read
|
||||||
@@ -48,42 +47,127 @@ jobs:
|
|||||||
|
|
||||||
## Inputs
|
## Inputs
|
||||||
|
|
||||||
| Input | Description | Required | Default |
|
| 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\* | - |
|
||||||
| `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\* | - |
|
||||||
| `claude_code_oauth_token` | Claude Code OAuth token (alternative to anthropic_api_key) | No\* | - |
|
| `prompt` | Instructions for Claude. Can be a direct prompt or custom template for automation workflows | No | - |
|
||||||
| `direct_prompt` | Direct prompt for Claude to execute automatically without needing a trigger (for automated workflows) | No | - |
|
| `claude_args` | Additional arguments to pass directly to Claude CLI (e.g., `--max-turns 10 --model claude-4-0-sonnet-20250805`) | 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 | - |
|
||||||
| `base_branch` | The base branch to use for creating new branches (e.g., 'main', 'develop') | No | - |
|
| `use_sticky_comment` | Use just one comment to deliver PR comments (only applies for pull_request event workflows) | No | `false` |
|
||||||
| `max_turns` | Maximum number of conversation turns Claude can take (limits back-and-forth exchanges) | No | - |
|
| `github_token` | GitHub token for Claude to operate with. **Only include this if you're connecting a custom GitHub app of your own!** | No | - |
|
||||||
| `timeout_minutes` | Timeout in minutes for execution | No | `30` |
|
| `use_bedrock` | Use Amazon Bedrock with OIDC authentication instead of direct Anthropic API | No | `false` |
|
||||||
| `use_sticky_comment` | Use just one comment to deliver PR comments (only applies for pull_request event workflows) | No | `false` |
|
| `use_vertex` | Use Google Vertex AI with OIDC authentication instead of direct Anthropic API | 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 | - |
|
| `mcp_config` | Additional MCP configuration (JSON string) that merges with the built-in GitHub MCP servers | No | "" |
|
||||||
| `model` | Model to use (provider-specific format required for Bedrock/Vertex) | No | - |
|
| `assignee_trigger` | The assignee username that triggers the action (e.g. @claude). Only used for issue assignment | No | - |
|
||||||
| `fallback_model` | Enable automatic fallback to specified model when primary model is unavailable | No | - |
|
| `label_trigger` | The label name that triggers the action when applied to an issue (e.g. "claude") | No | - |
|
||||||
| `anthropic_model` | **DEPRECATED**: Use `model` instead. Kept for backward compatibility. | No | - |
|
| `trigger_phrase` | The trigger phrase to look for in comments, issue/PR bodies, and issue titles | No | `@claude` |
|
||||||
| `use_bedrock` | Use Amazon Bedrock with OIDC authentication instead of direct Anthropic API | No | `false` |
|
| `branch_prefix` | The prefix to use for Claude branches (defaults to 'claude/', use 'claude-' for dash format) | No | `claude/` |
|
||||||
| `use_vertex` | Use Google Vertex AI with OIDC authentication instead of direct Anthropic API | No | `false` |
|
| `settings` | Claude Code settings as JSON string or path to settings JSON file | No | "" |
|
||||||
| `allowed_tools` | Additional tools for Claude to use (the base GitHub tools will always be included) | No | "" |
|
| `additional_permissions` | Additional permissions to enable. Currently supports 'actions: read' for viewing workflow results | No | "" |
|
||||||
| `disallowed_tools` | Tools that Claude should never use | No | "" |
|
| `experimental_allowed_domains` | Restrict network access to these domains only (newline-separated). | No | "" |
|
||||||
| `custom_instructions` | Additional custom instructions to include in the prompt for Claude | No | "" |
|
| `use_commit_signing` | Enable commit signing using GitHub's commit signature verification. When false, Claude uses standard git commands | No | `false` |
|
||||||
| `mcp_config` | Additional MCP configuration (JSON string) that merges with the built-in GitHub MCP servers | No | "" |
|
| `allowed_bots` | Comma-separated list of allowed bot usernames, or '\*' to allow all bots. Empty string (default) allows no bots | 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 | - |
|
### Deprecated Inputs
|
||||||
| `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/` |
|
These inputs are deprecated and will be removed in a future version:
|
||||||
| `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 | "" |
|
| Input | Description | Migration Path |
|
||||||
| `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 | "" |
|
| `mode` | **DEPRECATED**: Mode is now automatically detected based on workflow context | Remove this input; the action auto-detects the correct mode |
|
||||||
| `use_commit_signing` | Enable commit signing using GitHub's commit signature verification. When false, Claude uses standard git commands | No | `false` |
|
| `direct_prompt` | **DEPRECATED**: Use `prompt` instead | Replace with `prompt` |
|
||||||
| `allowed_bots` | Comma-separated list of allowed bot usernames, or '\*' to allow all bots. Empty string (default) allows no bots | No | "" |
|
| `override_prompt` | **DEPRECATED**: Use `prompt` with template variables or `claude_args` with `--system-prompt` | Use `prompt` for templates or `claude_args` for system prompts |
|
||||||
|
| `custom_instructions` | **DEPRECATED**: Use `claude_args` with `--system-prompt` or include in `prompt` | Move instructions to `prompt` or use `claude_args` |
|
||||||
|
| `max_turns` | **DEPRECATED**: Use `claude_args` with `--max-turns` instead | Use `claude_args: "--max-turns 5"` |
|
||||||
|
| `model` | **DEPRECATED**: Use `claude_args` with `--model` instead | Use `claude_args: "--model claude-4-0-sonnet-20250805"` |
|
||||||
|
| `fallback_model` | **DEPRECATED**: Use `claude_args` with fallback configuration | Configure fallback in `claude_args` or `settings` |
|
||||||
|
| `allowed_tools` | **DEPRECATED**: Use `claude_args` with `--allowedTools` instead | Use `claude_args: "--allowedTools Edit,Read,Write"` |
|
||||||
|
| `disallowed_tools` | **DEPRECATED**: Use `claude_args` with `--disallowedTools` instead | Use `claude_args: "--disallowedTools WebSearch"` |
|
||||||
|
| `claude_env` | **DEPRECATED**: Use `settings` with env configuration | Configure environment in `settings` JSON |
|
||||||
|
|
||||||
\*Required when using direct Anthropic API (default and when not using Bedrock or Vertex)
|
\*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.
|
> **Note**: This action is currently in beta. Features and APIs may change as we continue to improve the integration.
|
||||||
|
|
||||||
|
## Upgrading from v0.x?
|
||||||
|
|
||||||
|
For a comprehensive guide on migrating from v0.x to v1.0, including step-by-step instructions and examples, see our **[Migration Guide](./migration-guide.md)**.
|
||||||
|
|
||||||
|
### Quick Migration Examples
|
||||||
|
|
||||||
|
#### Interactive Workflows (with @claude mentions)
|
||||||
|
|
||||||
|
**Before (v0.x):**
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: anthropics/claude-code-action@beta
|
||||||
|
with:
|
||||||
|
mode: "tag"
|
||||||
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
|
custom_instructions: "Focus on security"
|
||||||
|
max_turns: "10"
|
||||||
|
```
|
||||||
|
|
||||||
|
**After (v1.0):**
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: anthropics/claude-code-action@v1
|
||||||
|
with:
|
||||||
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
|
claude_args: |
|
||||||
|
--max-turns 10
|
||||||
|
--system-prompt "Focus on security"
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Automation Workflows
|
||||||
|
|
||||||
|
**Before (v0.x):**
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: anthropics/claude-code-action@beta
|
||||||
|
with:
|
||||||
|
mode: "agent"
|
||||||
|
direct_prompt: "Update the API documentation"
|
||||||
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
|
model: "claude-4-0-sonnet-20250805"
|
||||||
|
allowed_tools: "Edit,Read,Write"
|
||||||
|
```
|
||||||
|
|
||||||
|
**After (v1.0):**
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: anthropics/claude-code-action@v1
|
||||||
|
with:
|
||||||
|
prompt: "Update the API documentation"
|
||||||
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
|
claude_args: |
|
||||||
|
--model claude-4-0-sonnet-20250805
|
||||||
|
--allowedTools Edit,Read,Write
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Custom Templates
|
||||||
|
|
||||||
|
**Before (v0.x):**
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: anthropics/claude-code-action@beta
|
||||||
|
with:
|
||||||
|
override_prompt: |
|
||||||
|
Analyze PR #$PR_NUMBER for security issues.
|
||||||
|
Focus on: $CHANGED_FILES
|
||||||
|
```
|
||||||
|
|
||||||
|
**After (v1.0):**
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: anthropics/claude-code-action@v1
|
||||||
|
with:
|
||||||
|
prompt: |
|
||||||
|
Analyze PR #${{ github.event.pull_request.number }} for security issues.
|
||||||
|
Focus on the changed files in this PR.
|
||||||
|
```
|
||||||
|
|
||||||
## Ways to Tag @claude
|
## 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.
|
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.
|
||||||
|
|||||||
97
examples/auto-fix-ci-signed/auto-fix-ci-signed.yml
Normal file
97
examples/auto-fix-ci-signed/auto-fix-ci-signed.yml
Normal file
@@ -0,0 +1,97 @@
|
|||||||
|
name: Auto Fix CI Failures (Signed Commits)
|
||||||
|
|
||||||
|
on:
|
||||||
|
workflow_run:
|
||||||
|
workflows: ["CI"]
|
||||||
|
types:
|
||||||
|
- completed
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: write
|
||||||
|
pull-requests: write
|
||||||
|
actions: read
|
||||||
|
issues: write
|
||||||
|
id-token: write # Required for OIDC token exchange
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
auto-fix-signed:
|
||||||
|
if: |
|
||||||
|
github.event.workflow_run.conclusion == 'failure' &&
|
||||||
|
github.event.workflow_run.pull_requests[0] &&
|
||||||
|
!startsWith(github.event.workflow_run.head_branch, 'claude-auto-fix-ci-signed-')
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
ref: ${{ github.event.workflow_run.head_branch }}
|
||||||
|
fetch-depth: 0
|
||||||
|
token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
|
||||||
|
- name: Generate fix branch name
|
||||||
|
id: branch
|
||||||
|
run: |
|
||||||
|
BRANCH_NAME="claude-auto-fix-ci-signed-${{ github.event.workflow_run.head_branch }}-${{ github.run_id }}"
|
||||||
|
echo "branch_name=$BRANCH_NAME" >> $GITHUB_OUTPUT
|
||||||
|
# Don't create branch locally - MCP tools will create it via API
|
||||||
|
echo "Generated branch name: $BRANCH_NAME (will be created by MCP tools)"
|
||||||
|
|
||||||
|
- name: Get CI failure details
|
||||||
|
id: failure_details
|
||||||
|
uses: actions/github-script@v7
|
||||||
|
with:
|
||||||
|
script: |
|
||||||
|
const run = await github.rest.actions.getWorkflowRun({
|
||||||
|
owner: context.repo.owner,
|
||||||
|
repo: context.repo.repo,
|
||||||
|
run_id: ${{ github.event.workflow_run.id }}
|
||||||
|
});
|
||||||
|
|
||||||
|
const jobs = await github.rest.actions.listJobsForWorkflowRun({
|
||||||
|
owner: context.repo.owner,
|
||||||
|
repo: context.repo.repo,
|
||||||
|
run_id: ${{ github.event.workflow_run.id }}
|
||||||
|
});
|
||||||
|
|
||||||
|
const failedJobs = jobs.data.jobs.filter(job => job.conclusion === 'failure');
|
||||||
|
|
||||||
|
let errorLogs = [];
|
||||||
|
for (const job of failedJobs) {
|
||||||
|
const logs = await github.rest.actions.downloadJobLogsForWorkflowRun({
|
||||||
|
owner: context.repo.owner,
|
||||||
|
repo: context.repo.repo,
|
||||||
|
job_id: job.id
|
||||||
|
});
|
||||||
|
errorLogs.push({
|
||||||
|
jobName: job.name,
|
||||||
|
logs: logs.data
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
runUrl: run.data.html_url,
|
||||||
|
failedJobs: failedJobs.map(j => j.name),
|
||||||
|
errorLogs: errorLogs
|
||||||
|
};
|
||||||
|
|
||||||
|
- name: Fix CI failures with Claude (Signed Commits)
|
||||||
|
id: claude
|
||||||
|
uses: anthropics/claude-code-action@v1-dev
|
||||||
|
env:
|
||||||
|
CLAUDE_BRANCH: ${{ steps.branch.outputs.branch_name }}
|
||||||
|
BASE_BRANCH: ${{ github.event.workflow_run.head_branch }}
|
||||||
|
with:
|
||||||
|
prompt: |
|
||||||
|
/fix-ci-signed
|
||||||
|
Failed CI Run: ${{ fromJSON(steps.failure_details.outputs.result).runUrl }}
|
||||||
|
Failed Jobs: ${{ join(fromJSON(steps.failure_details.outputs.result).failedJobs, ', ') }}
|
||||||
|
PR Number: ${{ github.event.workflow_run.pull_requests[0].number }}
|
||||||
|
Branch Name: ${{ steps.branch.outputs.branch_name }}
|
||||||
|
Base Branch: ${{ github.event.workflow_run.head_branch }}
|
||||||
|
Repository: ${{ github.repository }}
|
||||||
|
|
||||||
|
Error logs:
|
||||||
|
${{ toJSON(fromJSON(steps.failure_details.outputs.result).errorLogs) }}
|
||||||
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
|
use_commit_signing: true
|
||||||
|
claude_args: "--allowedTools 'Edit,MultiEdit,Write,Read,Glob,Grep,LS,Bash(bun:*),Bash(npm:*),Bash(npx:*),Bash(gh:*),mcp__github_file_ops__commit_files,mcp__github_file_ops__delete_files'"
|
||||||
148
examples/auto-fix-ci-signed/commands/fix-ci-signed.md
Normal file
148
examples/auto-fix-ci-signed/commands/fix-ci-signed.md
Normal file
@@ -0,0 +1,148 @@
|
|||||||
|
---
|
||||||
|
description: Analyze and fix CI failures with signed commits using MCP tools
|
||||||
|
allowed_tools: Edit,MultiEdit,Write,Read,Glob,Grep,LS,Bash(bun:*),Bash(npm:*),Bash(npx:*),Bash(gh:*),mcp__github_file_ops__commit_files,mcp__github_file_ops__delete_files
|
||||||
|
---
|
||||||
|
|
||||||
|
# Fix CI Failures with Signed Commits
|
||||||
|
|
||||||
|
You are tasked with analyzing CI failure logs and fixing the issues using MCP tools for signed commits. Follow these steps:
|
||||||
|
|
||||||
|
## Context Provided
|
||||||
|
|
||||||
|
$ARGUMENTS
|
||||||
|
|
||||||
|
## Important Context Information
|
||||||
|
|
||||||
|
Look for these key pieces of information in the arguments:
|
||||||
|
|
||||||
|
- **Failed CI Run URL**: Link to the failed CI run
|
||||||
|
- **Failed Jobs**: List of jobs that failed
|
||||||
|
- **PR Number**: The PR number to comment on
|
||||||
|
- **Branch Name**: The fix branch you're working on
|
||||||
|
- **Base Branch**: The original PR branch
|
||||||
|
- **Error logs**: Detailed logs from failed jobs
|
||||||
|
|
||||||
|
## CRITICAL: Use MCP Tools for Git Operations
|
||||||
|
|
||||||
|
**IMPORTANT**: You MUST use MCP tools for all git operations to ensure commits are properly signed. DO NOT use `git` commands directly via Bash.
|
||||||
|
|
||||||
|
- Use `mcp__github_file_ops__commit_files` to commit and push changes
|
||||||
|
- Use `mcp__github_file_ops__delete_files` to delete files
|
||||||
|
|
||||||
|
## Step 1: Analyze the Failure
|
||||||
|
|
||||||
|
Parse the provided CI failure information to understand:
|
||||||
|
|
||||||
|
- Which jobs failed and why
|
||||||
|
- The specific error messages and stack traces
|
||||||
|
- Whether failures are test-related, build-related, or linting issues
|
||||||
|
|
||||||
|
## Step 2: Search and Understand the Codebase
|
||||||
|
|
||||||
|
Use MCP search tools to locate the failing code:
|
||||||
|
|
||||||
|
- Use `mcp_github_file_ops_server__search_files` or `mcp_github_file_ops_server__file_search` to find failing test names or functions
|
||||||
|
- Use `mcp_github_file_ops_server__read_file` to read source files mentioned in error messages
|
||||||
|
- Review related configuration files (package.json, tsconfig.json, etc.)
|
||||||
|
|
||||||
|
## Step 3: Apply Targeted Fixes
|
||||||
|
|
||||||
|
Make minimal, focused changes:
|
||||||
|
|
||||||
|
- **For test failures**: Determine if the test or implementation needs fixing
|
||||||
|
- **For type errors**: Fix type definitions or correct the code logic
|
||||||
|
- **For linting issues**: Apply formatting using the project's tools
|
||||||
|
- **For build errors**: Resolve dependency or configuration issues
|
||||||
|
- **For missing imports**: Add the necessary imports or install packages
|
||||||
|
|
||||||
|
Requirements:
|
||||||
|
|
||||||
|
- Only fix the actual CI failures, avoid unrelated changes
|
||||||
|
- Follow existing code patterns and conventions
|
||||||
|
- Ensure changes are production-ready, not temporary hacks
|
||||||
|
- Preserve existing functionality while fixing issues
|
||||||
|
|
||||||
|
## Step 4: Verify Fixes Locally
|
||||||
|
|
||||||
|
Run available verification commands using Bash:
|
||||||
|
|
||||||
|
- Execute the failing tests locally to confirm they pass
|
||||||
|
- Run the project's lint command (check package.json for scripts)
|
||||||
|
- Run type checking if available
|
||||||
|
- Execute any build commands to ensure compilation succeeds
|
||||||
|
|
||||||
|
## Step 5: Commit and Push Changes Using MCP
|
||||||
|
|
||||||
|
**CRITICAL**: You MUST use MCP tools for committing and pushing:
|
||||||
|
|
||||||
|
1. Prepare all your file changes (using Edit/MultiEdit/Write tools as needed)
|
||||||
|
2. **Use `mcp__github_file_ops__commit_files` to commit and push all changes**
|
||||||
|
- Pass the file paths you've edited in the `files` array
|
||||||
|
- Set `message` to describe the specific fixes (e.g., "Fix CI failures: remove syntax errors and format code")
|
||||||
|
- The MCP tool will automatically create the branch specified in "Branch Name:" from the context and push signed commits
|
||||||
|
|
||||||
|
**IMPORTANT**: The MCP tool will create the branch from the context automatically. The branch name from "Branch Name:" in the context will be used.
|
||||||
|
|
||||||
|
Example usage:
|
||||||
|
|
||||||
|
```
|
||||||
|
mcp__github_file_ops__commit_files with:
|
||||||
|
- files: ["src/utils/retry.ts", "src/other/file.ts"] // List of file paths you edited
|
||||||
|
- message: "Fix CI failures: [describe specific fixes]"
|
||||||
|
```
|
||||||
|
|
||||||
|
Note: The branch will be created from the Base Branch specified in the context.
|
||||||
|
|
||||||
|
## Step 6: Create PR Comment (REQUIRED - DO NOT SKIP)
|
||||||
|
|
||||||
|
**CRITICAL: You MUST create a PR comment after pushing. This step is MANDATORY.**
|
||||||
|
|
||||||
|
After successfully pushing the fixes, you MUST create a comment on the original PR to notify about the auto-fix. DO NOT end the task without completing this step.
|
||||||
|
|
||||||
|
1. Extract the PR number from the context provided in arguments (look for "PR Number:" in the context)
|
||||||
|
2. **MANDATORY**: Execute the gh CLI command below to create the comment
|
||||||
|
3. Verify the comment was created successfully
|
||||||
|
|
||||||
|
**YOU MUST RUN THIS COMMAND** (replace placeholders with actual values from context):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
gh pr comment PR_NUMBER --body "## 🤖 CI Auto-Fix Available (Signed Commits)
|
||||||
|
|
||||||
|
Claude has analyzed the CI failures and prepared fixes with signed commits.
|
||||||
|
|
||||||
|
[**→ Create pull request to fix CI**](https://github.com/OWNER/REPO/compare/BASE_BRANCH...FIX_BRANCH?quick_pull=1)
|
||||||
|
|
||||||
|
_This fix was generated automatically based on the [failed CI run](FAILED_CI_RUN_URL)._"
|
||||||
|
```
|
||||||
|
|
||||||
|
**IMPORTANT REPLACEMENTS YOU MUST MAKE:**
|
||||||
|
|
||||||
|
- Replace `PR_NUMBER` with the actual PR number from "PR Number:" in context
|
||||||
|
- Replace `OWNER/REPO` with the repository from "Repository:" in context
|
||||||
|
- Replace `BASE_BRANCH` with the branch from "Base Branch:" in context
|
||||||
|
- Replace `FIX_BRANCH` with the branch from "Branch Name:" in context
|
||||||
|
- Replace `FAILED_CI_RUN_URL` with the URL from "Failed CI Run:" in context
|
||||||
|
|
||||||
|
**DO NOT SKIP THIS STEP. The task is NOT complete until the PR comment is created.**
|
||||||
|
|
||||||
|
## Step 7: Final Verification
|
||||||
|
|
||||||
|
**BEFORE CONSIDERING THE TASK COMPLETE**, verify you have:
|
||||||
|
|
||||||
|
1. ✅ Fixed all CI failures
|
||||||
|
2. ✅ Committed the changes using `mcp_github_file_ops_server__push_files`
|
||||||
|
3. ✅ Verified the branch was pushed successfully
|
||||||
|
4. ✅ **CREATED THE PR COMMENT using `gh pr comment` command from Step 6**
|
||||||
|
|
||||||
|
If you have NOT created the PR comment, go back to Step 6 and execute the command.
|
||||||
|
|
||||||
|
## Important Guidelines
|
||||||
|
|
||||||
|
- Always use MCP tools for git operations to ensure proper commit signing
|
||||||
|
- Focus exclusively on fixing the reported CI failures
|
||||||
|
- Maintain code quality and follow the project's established patterns
|
||||||
|
- If a fix requires significant refactoring, document why it's necessary
|
||||||
|
- When multiple solutions exist, choose the simplest one that maintains code quality
|
||||||
|
- **THE TASK IS NOT COMPLETE WITHOUT THE PR COMMENT**
|
||||||
|
|
||||||
|
Begin by analyzing the failure details provided above.
|
||||||
97
examples/auto-fix-ci/auto-fix-ci.yml
Normal file
97
examples/auto-fix-ci/auto-fix-ci.yml
Normal file
@@ -0,0 +1,97 @@
|
|||||||
|
name: Auto Fix CI Failures
|
||||||
|
|
||||||
|
on:
|
||||||
|
workflow_run:
|
||||||
|
workflows: ["CI"]
|
||||||
|
types:
|
||||||
|
- completed
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: write
|
||||||
|
pull-requests: write
|
||||||
|
actions: read
|
||||||
|
issues: write
|
||||||
|
id-token: write # Required for OIDC token exchange
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
auto-fix:
|
||||||
|
if: |
|
||||||
|
github.event.workflow_run.conclusion == 'failure' &&
|
||||||
|
github.event.workflow_run.pull_requests[0] &&
|
||||||
|
!startsWith(github.event.workflow_run.head_branch, 'claude-auto-fix-ci-')
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
ref: ${{ github.event.workflow_run.head_branch }}
|
||||||
|
fetch-depth: 0
|
||||||
|
token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
|
||||||
|
- name: Setup git identity
|
||||||
|
run: |
|
||||||
|
git config --global user.email "claude[bot]@users.noreply.github.com"
|
||||||
|
git config --global user.name "claude[bot]"
|
||||||
|
|
||||||
|
- name: Create fix branch
|
||||||
|
id: branch
|
||||||
|
run: |
|
||||||
|
BRANCH_NAME="claude-auto-fix-ci-${{ github.event.workflow_run.head_branch }}-${{ github.run_id }}"
|
||||||
|
git checkout -b "$BRANCH_NAME"
|
||||||
|
echo "branch_name=$BRANCH_NAME" >> $GITHUB_OUTPUT
|
||||||
|
|
||||||
|
- name: Get CI failure details
|
||||||
|
id: failure_details
|
||||||
|
uses: actions/github-script@v7
|
||||||
|
with:
|
||||||
|
script: |
|
||||||
|
const run = await github.rest.actions.getWorkflowRun({
|
||||||
|
owner: context.repo.owner,
|
||||||
|
repo: context.repo.repo,
|
||||||
|
run_id: ${{ github.event.workflow_run.id }}
|
||||||
|
});
|
||||||
|
|
||||||
|
const jobs = await github.rest.actions.listJobsForWorkflowRun({
|
||||||
|
owner: context.repo.owner,
|
||||||
|
repo: context.repo.repo,
|
||||||
|
run_id: ${{ github.event.workflow_run.id }}
|
||||||
|
});
|
||||||
|
|
||||||
|
const failedJobs = jobs.data.jobs.filter(job => job.conclusion === 'failure');
|
||||||
|
|
||||||
|
let errorLogs = [];
|
||||||
|
for (const job of failedJobs) {
|
||||||
|
const logs = await github.rest.actions.downloadJobLogsForWorkflowRun({
|
||||||
|
owner: context.repo.owner,
|
||||||
|
repo: context.repo.repo,
|
||||||
|
job_id: job.id
|
||||||
|
});
|
||||||
|
errorLogs.push({
|
||||||
|
jobName: job.name,
|
||||||
|
logs: logs.data
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
runUrl: run.data.html_url,
|
||||||
|
failedJobs: failedJobs.map(j => j.name),
|
||||||
|
errorLogs: errorLogs
|
||||||
|
};
|
||||||
|
|
||||||
|
- name: Fix CI failures with Claude
|
||||||
|
id: claude
|
||||||
|
uses: anthropics/claude-code-action@v1-dev
|
||||||
|
with:
|
||||||
|
prompt: |
|
||||||
|
/fix-ci
|
||||||
|
Failed CI Run: ${{ fromJSON(steps.failure_details.outputs.result).runUrl }}
|
||||||
|
Failed Jobs: ${{ join(fromJSON(steps.failure_details.outputs.result).failedJobs, ', ') }}
|
||||||
|
PR Number: ${{ github.event.workflow_run.pull_requests[0].number }}
|
||||||
|
Branch Name: ${{ steps.branch.outputs.branch_name }}
|
||||||
|
Base Branch: ${{ github.event.workflow_run.head_branch }}
|
||||||
|
Repository: ${{ github.repository }}
|
||||||
|
|
||||||
|
Error logs:
|
||||||
|
${{ toJSON(fromJSON(steps.failure_details.outputs.result).errorLogs) }}
|
||||||
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
|
claude_args: "--allowedTools 'Edit,MultiEdit,Write,Read,Glob,Grep,LS,Bash(git:*),Bash(bun:*),Bash(npm:*),Bash(npx:*),Bash(gh:*)'"
|
||||||
127
examples/auto-fix-ci/commands/fix-ci.md
Normal file
127
examples/auto-fix-ci/commands/fix-ci.md
Normal file
@@ -0,0 +1,127 @@
|
|||||||
|
---
|
||||||
|
description: Analyze and fix CI failures by examining logs and making targeted fixes
|
||||||
|
allowed_tools: Edit,MultiEdit,Write,Read,Glob,Grep,LS,Bash(git:*),Bash(bun:*),Bash(npm:*),Bash(npx:*),Bash(gh:*)
|
||||||
|
---
|
||||||
|
|
||||||
|
# Fix CI Failures
|
||||||
|
|
||||||
|
You are tasked with analyzing CI failure logs and fixing the issues. Follow these steps:
|
||||||
|
|
||||||
|
## Context Provided
|
||||||
|
|
||||||
|
$ARGUMENTS
|
||||||
|
|
||||||
|
## Important Context Information
|
||||||
|
|
||||||
|
Look for these key pieces of information in the arguments:
|
||||||
|
|
||||||
|
- **Failed CI Run URL**: Link to the failed CI run
|
||||||
|
- **Failed Jobs**: List of jobs that failed
|
||||||
|
- **PR Number**: The PR number to comment on
|
||||||
|
- **Branch Name**: The fix branch you're working on
|
||||||
|
- **Base Branch**: The original PR branch
|
||||||
|
- **Error logs**: Detailed logs from failed jobs
|
||||||
|
|
||||||
|
## Step 1: Analyze the Failure
|
||||||
|
|
||||||
|
Parse the provided CI failure information to understand:
|
||||||
|
|
||||||
|
- Which jobs failed and why
|
||||||
|
- The specific error messages and stack traces
|
||||||
|
- Whether failures are test-related, build-related, or linting issues
|
||||||
|
|
||||||
|
## Step 2: Search and Understand the Codebase
|
||||||
|
|
||||||
|
Use search tools to locate the failing code:
|
||||||
|
|
||||||
|
- Search for the failing test names or functions
|
||||||
|
- Find the source files mentioned in error messages
|
||||||
|
- Review related configuration files (package.json, tsconfig.json, etc.)
|
||||||
|
|
||||||
|
## Step 3: Apply Targeted Fixes
|
||||||
|
|
||||||
|
Make minimal, focused changes:
|
||||||
|
|
||||||
|
- **For test failures**: Determine if the test or implementation needs fixing
|
||||||
|
- **For type errors**: Fix type definitions or correct the code logic
|
||||||
|
- **For linting issues**: Apply formatting using the project's tools
|
||||||
|
- **For build errors**: Resolve dependency or configuration issues
|
||||||
|
- **For missing imports**: Add the necessary imports or install packages
|
||||||
|
|
||||||
|
Requirements:
|
||||||
|
|
||||||
|
- Only fix the actual CI failures, avoid unrelated changes
|
||||||
|
- Follow existing code patterns and conventions
|
||||||
|
- Ensure changes are production-ready, not temporary hacks
|
||||||
|
- Preserve existing functionality while fixing issues
|
||||||
|
|
||||||
|
## Step 4: Verify Fixes Locally
|
||||||
|
|
||||||
|
Run available verification commands:
|
||||||
|
|
||||||
|
- Execute the failing tests locally to confirm they pass
|
||||||
|
- Run the project's lint command (check package.json for scripts)
|
||||||
|
- Run type checking if available
|
||||||
|
- Execute any build commands to ensure compilation succeeds
|
||||||
|
|
||||||
|
## Step 5: Commit and Push Changes
|
||||||
|
|
||||||
|
After applying ALL fixes:
|
||||||
|
|
||||||
|
1. Stage all modified files with `git add -A`
|
||||||
|
2. Commit with: `git commit -m "Fix CI failures: [describe specific fixes]"`
|
||||||
|
3. Document which CI jobs/tests were addressed
|
||||||
|
4. **CRITICAL**: Push the branch with `git push origin HEAD` - You MUST push the branch after committing
|
||||||
|
|
||||||
|
## Step 6: Create PR Comment (REQUIRED - DO NOT SKIP)
|
||||||
|
|
||||||
|
**CRITICAL: You MUST create a PR comment after pushing. This step is MANDATORY.**
|
||||||
|
|
||||||
|
After successfully pushing the fixes, you MUST create a comment on the original PR to notify about the auto-fix. DO NOT end the task without completing this step.
|
||||||
|
|
||||||
|
1. Extract the PR number from the context provided in arguments (look for "PR Number:" in the context)
|
||||||
|
2. **MANDATORY**: Execute the gh CLI command below to create the comment
|
||||||
|
3. Verify the comment was created successfully
|
||||||
|
|
||||||
|
**YOU MUST RUN THIS COMMAND** (replace placeholders with actual values from context):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
gh pr comment PR_NUMBER --body "## 🤖 CI Auto-Fix Available
|
||||||
|
|
||||||
|
Claude has analyzed the CI failures and prepared fixes.
|
||||||
|
|
||||||
|
[**→ Create pull request to fix CI**](https://github.com/OWNER/REPO/compare/BASE_BRANCH...FIX_BRANCH?quick_pull=1)
|
||||||
|
|
||||||
|
_This fix was generated automatically based on the [failed CI run](FAILED_CI_RUN_URL)._"
|
||||||
|
```
|
||||||
|
|
||||||
|
**IMPORTANT REPLACEMENTS YOU MUST MAKE:**
|
||||||
|
|
||||||
|
- Replace `PR_NUMBER` with the actual PR number from "PR Number:" in context
|
||||||
|
- Replace `OWNER/REPO` with the repository from "Repository:" in context
|
||||||
|
- Replace `BASE_BRANCH` with the branch from "Base Branch:" in context
|
||||||
|
- Replace `FIX_BRANCH` with the branch from "Branch Name:" in context
|
||||||
|
- Replace `FAILED_CI_RUN_URL` with the URL from "Failed CI Run:" in context
|
||||||
|
|
||||||
|
**DO NOT SKIP THIS STEP. The task is NOT complete until the PR comment is created.**
|
||||||
|
|
||||||
|
## Step 7: Final Verification
|
||||||
|
|
||||||
|
**BEFORE CONSIDERING THE TASK COMPLETE**, verify you have:
|
||||||
|
|
||||||
|
1. ✅ Fixed all CI failures
|
||||||
|
2. ✅ Committed the changes
|
||||||
|
3. ✅ Pushed the branch with `git push origin HEAD`
|
||||||
|
4. ✅ **CREATED THE PR COMMENT using `gh pr comment` command from Step 6**
|
||||||
|
|
||||||
|
If you have NOT created the PR comment, go back to Step 6 and execute the command.
|
||||||
|
|
||||||
|
## Important Guidelines
|
||||||
|
|
||||||
|
- Focus exclusively on fixing the reported CI failures
|
||||||
|
- Maintain code quality and follow the project's established patterns
|
||||||
|
- If a fix requires significant refactoring, document why it's necessary
|
||||||
|
- When multiple solutions exist, choose the simplest one that maintains code quality
|
||||||
|
- **THE TASK IS NOT COMPLETE WITHOUT THE PR COMMENT**
|
||||||
|
|
||||||
|
Begin by analyzing the failure details provided above.
|
||||||
@@ -15,15 +15,13 @@ jobs:
|
|||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
- name: Run Claude with custom arguments
|
- name: Run Claude with custom arguments
|
||||||
uses: anthropics/claude-code-action@v1
|
uses: anthropics/claude-code-action@v1-dev
|
||||||
with:
|
with:
|
||||||
mode: agent
|
|
||||||
prompt: ${{ github.event.inputs.prompt }}
|
prompt: ${{ github.event.inputs.prompt }}
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
|
|
||||||
# New claudeArgs input allows direct CLI argument control
|
# claude_args provides direct CLI argument control
|
||||||
# Order: -p [claudeArgs] [legacy options] [BASE_ARGS]
|
# This allows full customization of Claude's behavior
|
||||||
# Note: BASE_ARGS (--verbose --output-format stream-json) cannot be overridden
|
|
||||||
claude_args: |
|
claude_args: |
|
||||||
--max-turns 15
|
--max-turns 15
|
||||||
--model claude-opus-4-1-20250805
|
--model claude-opus-4-1-20250805
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
name: Claude Auto Review
|
name: Claude PR Auto Review
|
||||||
|
|
||||||
on:
|
on:
|
||||||
pull_request:
|
pull_request:
|
||||||
@@ -18,12 +18,16 @@ jobs:
|
|||||||
fetch-depth: 1
|
fetch-depth: 1
|
||||||
|
|
||||||
- name: Automatic PR Review
|
- name: Automatic PR Review
|
||||||
uses: anthropics/claude-code-action@v1
|
uses: anthropics/claude-code-action@v1-dev
|
||||||
with:
|
with:
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
timeout_minutes: "60"
|
|
||||||
prompt: |
|
prompt: |
|
||||||
Please review this pull request and provide comprehensive feedback.
|
REPO: ${{ github.repository }}
|
||||||
|
PR NUMBER: ${{ github.event.pull_request.number }}
|
||||||
|
|
||||||
|
Please review this pull request.
|
||||||
|
|
||||||
|
Note: The PR branch is already checked out in the current working directory.
|
||||||
|
|
||||||
Focus on:
|
Focus on:
|
||||||
- Code quality and best practices
|
- Code quality and best practices
|
||||||
@@ -32,7 +36,13 @@ jobs:
|
|||||||
- Security implications
|
- Security implications
|
||||||
- Test coverage
|
- Test coverage
|
||||||
- Documentation updates if needed
|
- Documentation updates if needed
|
||||||
|
- Verify that README.md and docs are updated for any new features or config changes
|
||||||
|
|
||||||
Provide constructive feedback with specific suggestions for improvement.
|
Provide constructive feedback with specific suggestions for improvement.
|
||||||
Use inline comments to highlight specific areas of concern.
|
Use `gh pr comment:*` for top-level comments.
|
||||||
# allowed_tools: "mcp__github__create_pending_pull_request_review,mcp__github__add_comment_to_pending_review,mcp__github__submit_pending_pull_request_review,mcp__github__get_pull_request_diff"
|
Use `mcp__github_inline_comment__create_inline_comment` to highlight specific areas of concern.
|
||||||
|
Only your GitHub comments that you post will be seen, so don't submit your review as a normal message, just as comments.
|
||||||
|
If the PR has already been reviewed, or there are no noteworthy changes, don't post anything.
|
||||||
|
|
||||||
|
claude_args: |
|
||||||
|
--allowedTools "mcp__github_inline_comment__create_inline_comment,Bash(gh pr comment:*), Bash(gh pr diff:*), Bash(gh pr view:*)"
|
||||||
|
|||||||
@@ -1,46 +0,0 @@
|
|||||||
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@v1
|
|
||||||
with:
|
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
|
||||||
# github_token not needed - uses default GITHUB_TOKEN for GitHub operations
|
|
||||||
timeout_minutes: "30"
|
|
||||||
prompt: |
|
|
||||||
Review this pull request comprehensively.
|
|
||||||
|
|
||||||
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,21 +1,21 @@
|
|||||||
name: Claude Mode Examples
|
name: Claude Automatic Mode Detection Examples
|
||||||
|
|
||||||
on:
|
on:
|
||||||
# Events for tag mode
|
# Events for interactive mode (responds to @claude mentions)
|
||||||
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)
|
# Events for automation mode (runs with explicit prompt)
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
schedule:
|
schedule:
|
||||||
- cron: "0 0 * * 0" # Weekly on Sunday
|
- cron: "0 0 * * 0" # Weekly on Sunday
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
# Tag Mode (Default) - Traditional implementation
|
# Interactive Mode - Activated automatically when no prompt is provided
|
||||||
tag-mode-example:
|
interactive-mode-example:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
permissions:
|
permissions:
|
||||||
contents: write
|
contents: write
|
||||||
@@ -23,18 +23,17 @@ jobs:
|
|||||||
issues: write
|
issues: write
|
||||||
id-token: write
|
id-token: write
|
||||||
steps:
|
steps:
|
||||||
- uses: anthropics/claude-code-action@beta
|
- uses: anthropics/claude-code-action@v1-dev
|
||||||
with:
|
with:
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
# Tag mode (default) behavior:
|
# Interactive mode (auto-detected when no prompt):
|
||||||
# - Scans for @claude mentions in comments, issues, and PRs
|
# - Scans for @claude mentions in comments, issues, and PRs
|
||||||
# - Only acts when trigger phrase is found
|
# - Only acts when trigger phrase is found
|
||||||
# - 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 for workflow_dispatch and schedule events
|
# Automation Mode - Activated automatically when prompt is provided
|
||||||
agent-mode-scheduled-task:
|
automation-mode-scheduled-task:
|
||||||
# Only works with workflow_dispatch or schedule events
|
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
permissions:
|
permissions:
|
||||||
contents: write
|
contents: write
|
||||||
@@ -42,15 +41,14 @@ jobs:
|
|||||||
issues: write
|
issues: write
|
||||||
id-token: write
|
id-token: write
|
||||||
steps:
|
steps:
|
||||||
- uses: anthropics/claude-code-action@beta
|
- uses: anthropics/claude-code-action@v1-dev
|
||||||
with:
|
with:
|
||||||
mode: agent
|
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
override_prompt: |
|
prompt: |
|
||||||
Check for outdated dependencies and security vulnerabilities.
|
Check for outdated dependencies and security vulnerabilities.
|
||||||
Create an issue if any critical problems are found.
|
Create an issue if any critical problems are found.
|
||||||
# Agent mode behavior:
|
# Automation mode (auto-detected when prompt provided):
|
||||||
# - ONLY works with workflow_dispatch and schedule events
|
# - Works with any GitHub event
|
||||||
# - Does NOT work with pull_request, issues, or issue_comment events
|
# - Executes immediately without waiting for @claude mentions
|
||||||
# - No @claude mention needed for supported events
|
# - No tracking comments created
|
||||||
# - Perfect for: scheduled maintenance, manual automation runs
|
# - Perfect for: scheduled maintenance, automated reviews, CI/CD tasks
|
||||||
|
|||||||
@@ -24,12 +24,17 @@ jobs:
|
|||||||
fetch-depth: 1
|
fetch-depth: 1
|
||||||
|
|
||||||
- name: Claude Code Review
|
- name: Claude Code Review
|
||||||
uses: anthropics/claude-code-action@v1
|
uses: anthropics/claude-code-action@v1-dev
|
||||||
with:
|
with:
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
timeout_minutes: "60"
|
|
||||||
prompt: |
|
prompt: |
|
||||||
|
REPO: ${{ github.repository }}
|
||||||
|
PR NUMBER: ${{ github.event.pull_request.number }}
|
||||||
|
|
||||||
Please review this pull request focusing on the changed files.
|
Please review this pull request focusing on the changed files.
|
||||||
|
|
||||||
|
Note: The PR branch is already checked out in the current working directory.
|
||||||
|
|
||||||
Provide feedback on:
|
Provide feedback on:
|
||||||
- Code quality and adherence to best practices
|
- Code quality and adherence to best practices
|
||||||
- Potential bugs or edge cases
|
- Potential bugs or edge cases
|
||||||
@@ -39,3 +44,6 @@ jobs:
|
|||||||
|
|
||||||
Since this PR touches critical source code paths, please be thorough
|
Since this PR touches critical source code paths, please be thorough
|
||||||
in your review and provide inline comments where appropriate.
|
in your review and provide inline comments where appropriate.
|
||||||
|
|
||||||
|
claude_args: |
|
||||||
|
--allowedTools "mcp__github_inline_comment__create_inline_comment,Bash(gh pr comment:*), Bash(gh pr diff:*), Bash(gh pr view:*)"
|
||||||
|
|||||||
@@ -23,13 +23,17 @@ jobs:
|
|||||||
fetch-depth: 1
|
fetch-depth: 1
|
||||||
|
|
||||||
- name: Review PR from Specific Author
|
- name: Review PR from Specific Author
|
||||||
uses: anthropics/claude-code-action@v1
|
uses: anthropics/claude-code-action@v1-dev
|
||||||
with:
|
with:
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
timeout_minutes: "60"
|
|
||||||
prompt: |
|
prompt: |
|
||||||
|
REPO: ${{ github.repository }}
|
||||||
|
PR NUMBER: ${{ github.event.pull_request.number }}
|
||||||
|
|
||||||
Please provide a thorough review of this pull request.
|
Please provide a thorough review of this pull request.
|
||||||
|
|
||||||
|
Note: The PR branch is already checked out in the current working directory.
|
||||||
|
|
||||||
Since this is from a specific author that requires careful review,
|
Since this is from a specific author that requires careful review,
|
||||||
please pay extra attention to:
|
please pay extra attention to:
|
||||||
- Adherence to project coding standards
|
- Adherence to project coding standards
|
||||||
@@ -39,3 +43,6 @@ jobs:
|
|||||||
- Documentation
|
- Documentation
|
||||||
|
|
||||||
Provide detailed feedback and suggestions for improvement.
|
Provide detailed feedback and suggestions for improvement.
|
||||||
|
|
||||||
|
claude_args: |
|
||||||
|
--allowedTools "mcp__github_inline_comment__create_inline_comment,Bash(gh pr comment:*), Bash(gh pr diff:*), Bash(gh pr view:*)"
|
||||||
|
|||||||
@@ -32,7 +32,7 @@ jobs:
|
|||||||
|
|
||||||
- name: Run Claude Code
|
- name: Run Claude Code
|
||||||
id: claude
|
id: claude
|
||||||
uses: anthropics/claude-code-action@beta
|
uses: anthropics/claude-code-action@v1-dev
|
||||||
with:
|
with:
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
|
|
||||||
@@ -40,24 +40,23 @@ jobs:
|
|||||||
additional_permissions: |
|
additional_permissions: |
|
||||||
actions: read
|
actions: read
|
||||||
|
|
||||||
# Optional: Specify model (defaults to Claude Sonnet 4, uncomment for Claude Opus 4.1)
|
|
||||||
# model: "claude-opus-4-1-20250805"
|
|
||||||
|
|
||||||
# Optional: Customize the trigger phrase (default: @claude)
|
# Optional: Customize the trigger phrase (default: @claude)
|
||||||
# trigger_phrase: "/claude"
|
# trigger_phrase: "/claude"
|
||||||
|
|
||||||
# Optional: Trigger when specific user is assigned to an issue
|
# Optional: Trigger when specific user is assigned to an issue
|
||||||
# assignee_trigger: "claude-bot"
|
# assignee_trigger: "claude-bot"
|
||||||
|
|
||||||
# Optional: Allow Claude to run specific commands
|
# Optional: Configure Claude's behavior with CLI arguments
|
||||||
# allowed_tools: "Bash(npm install),Bash(npm run build),Bash(npm run test:*),Bash(npm run lint:*)"
|
# claude_args: |
|
||||||
|
# --model claude-opus-4-1-20250805
|
||||||
|
# --max-turns 10
|
||||||
|
# --allowedTools "Bash(npm install),Bash(npm run build),Bash(npm run test:*),Bash(npm run lint:*)"
|
||||||
|
# --system-prompt "Follow our coding standards. Ensure all new code has tests. Use TypeScript for new files."
|
||||||
|
|
||||||
# Optional: Add custom instructions for Claude to customize its behavior for your project
|
# Optional: Advanced settings configuration
|
||||||
# custom_instructions: |
|
# settings: |
|
||||||
# Follow our coding standards
|
# {
|
||||||
# Ensure all new code has tests
|
# "env": {
|
||||||
# Use TypeScript for new files
|
# "NODE_ENV": "test"
|
||||||
|
# }
|
||||||
# Optional: Custom environment variables for Claude
|
# }
|
||||||
# claude_env: |
|
|
||||||
# NODE_ENV: test
|
|
||||||
|
|||||||
63
examples/issue-deduplication.yml
Normal file
63
examples/issue-deduplication.yml
Normal file
@@ -0,0 +1,63 @@
|
|||||||
|
name: Issue Deduplication
|
||||||
|
|
||||||
|
on:
|
||||||
|
issues:
|
||||||
|
types: [opened]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
deduplicate:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
timeout-minutes: 10
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
issues: write
|
||||||
|
id-token: write
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout repository
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
fetch-depth: 1
|
||||||
|
|
||||||
|
- name: Check for duplicate issues
|
||||||
|
uses: anthropics/claude-code-action@v1-dev
|
||||||
|
with:
|
||||||
|
prompt: |
|
||||||
|
Analyze this new issue and check if it's a duplicate of existing issues in the repository.
|
||||||
|
|
||||||
|
Issue: #${{ github.event.issue.number }}
|
||||||
|
Repository: ${{ github.repository }}
|
||||||
|
|
||||||
|
Your task:
|
||||||
|
1. Use mcp__github__get_issue to get details of the current issue (#${{ github.event.issue.number }})
|
||||||
|
2. Search for similar existing issues using mcp__github__search_issues with relevant keywords from the issue title and body
|
||||||
|
3. Compare the new issue with existing ones to identify potential duplicates
|
||||||
|
|
||||||
|
Criteria for duplicates:
|
||||||
|
- Same bug or error being reported
|
||||||
|
- Same feature request (even if worded differently)
|
||||||
|
- Same question being asked
|
||||||
|
- Issues describing the same root problem
|
||||||
|
|
||||||
|
If you find duplicates:
|
||||||
|
- Add a comment on the new issue linking to the original issue(s)
|
||||||
|
- Apply a "duplicate" label to the new issue
|
||||||
|
- Be polite and explain why it's a duplicate
|
||||||
|
- Suggest the user follow the original issue for updates
|
||||||
|
|
||||||
|
If it's NOT a duplicate:
|
||||||
|
- Don't add any comments
|
||||||
|
- You may apply appropriate topic labels based on the issue content
|
||||||
|
|
||||||
|
Use these tools:
|
||||||
|
- mcp__github__get_issue: Get issue details
|
||||||
|
- mcp__github__search_issues: Search for similar issues
|
||||||
|
- mcp__github__list_issues: List recent issues if needed
|
||||||
|
- mcp__github__create_issue_comment: Add a comment if duplicate found
|
||||||
|
- mcp__github__update_issue: Add labels
|
||||||
|
|
||||||
|
Be thorough but efficient. Focus on finding true duplicates, not just similar issues.
|
||||||
|
|
||||||
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
|
claude_args: |
|
||||||
|
--allowedTools "mcp__github__get_issue,mcp__github__search_issues,mcp__github__list_issues,mcp__github__create_issue_comment,mcp__github__update_issue,mcp__github__get_issue_comments"
|
||||||
75
examples/issue-triage.yml
Normal file
75
examples/issue-triage.yml
Normal file
@@ -0,0 +1,75 @@
|
|||||||
|
name: Issue Triage
|
||||||
|
on:
|
||||||
|
issues:
|
||||||
|
types: [opened]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
triage-issue:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
timeout-minutes: 10
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
issues: write
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout repository
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
|
||||||
|
- name: Triage issue with Claude
|
||||||
|
uses: anthropics/claude-code-action@v1-dev
|
||||||
|
with:
|
||||||
|
prompt: |
|
||||||
|
You're an issue triage assistant for GitHub issues. Your task is to analyze the issue and select appropriate labels from the provided list.
|
||||||
|
|
||||||
|
IMPORTANT: Don't post any comments or messages to the issue. Your only action should be to apply labels.
|
||||||
|
|
||||||
|
Issue Information:
|
||||||
|
- REPO: ${{ github.repository }}
|
||||||
|
- ISSUE_NUMBER: ${{ github.event.issue.number }}
|
||||||
|
|
||||||
|
TASK OVERVIEW:
|
||||||
|
|
||||||
|
1. First, fetch the list of labels available in this repository by running: `gh label list`. Run exactly this command with nothing else.
|
||||||
|
|
||||||
|
2. Next, use the GitHub tools to get context about the issue:
|
||||||
|
- You have access to these tools:
|
||||||
|
- mcp__github__get_issue: Use this to retrieve the current issue's details including title, description, and existing labels
|
||||||
|
- mcp__github__get_issue_comments: Use this to read any discussion or additional context provided in the comments
|
||||||
|
- mcp__github__update_issue: Use this to apply labels to the issue (do not use this for commenting)
|
||||||
|
- mcp__github__search_issues: Use this to find similar issues that might provide context for proper categorization and to identify potential duplicate issues
|
||||||
|
- mcp__github__list_issues: Use this to understand patterns in how other issues are labeled
|
||||||
|
- Start by using mcp__github__get_issue to get the issue details
|
||||||
|
|
||||||
|
3. Analyze the issue content, considering:
|
||||||
|
- The issue title and description
|
||||||
|
- The type of issue (bug report, feature request, question, etc.)
|
||||||
|
- Technical areas mentioned
|
||||||
|
- Severity or priority indicators
|
||||||
|
- User impact
|
||||||
|
- Components affected
|
||||||
|
|
||||||
|
4. Select appropriate labels from the available labels list provided above:
|
||||||
|
- Choose labels that accurately reflect the issue's nature
|
||||||
|
- Be specific but comprehensive
|
||||||
|
- Select priority labels if you can determine urgency (high-priority, med-priority, or low-priority)
|
||||||
|
- Consider platform labels (android, ios) if applicable
|
||||||
|
- If you find similar issues using mcp__github__search_issues, consider using a "duplicate" label if appropriate. Only do so if the issue is a duplicate of another OPEN issue.
|
||||||
|
|
||||||
|
5. Apply the selected labels:
|
||||||
|
- Use mcp__github__update_issue to apply your selected labels
|
||||||
|
- DO NOT post any comments explaining your decision
|
||||||
|
- DO NOT communicate directly with users
|
||||||
|
- If no labels are clearly applicable, do not apply any labels
|
||||||
|
|
||||||
|
IMPORTANT GUIDELINES:
|
||||||
|
- Be thorough in your analysis
|
||||||
|
- Only select labels from the provided list above
|
||||||
|
- DO NOT post any comments to the issue
|
||||||
|
- Your ONLY action should be to apply labels using mcp__github__update_issue
|
||||||
|
- It's okay to not add any labels if none are clearly applicable
|
||||||
|
|
||||||
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
|
claude_args: |
|
||||||
|
--allowedTools "Bash(gh label list),mcp__github__get_issue,mcp__github__get_issue_comments,mcp__github__update_issue,mcp__github__search_issues,mcp__github__list_issues"
|
||||||
@@ -28,11 +28,10 @@ jobs:
|
|||||||
fetch-depth: 2 # Need at least 2 commits to analyze the latest
|
fetch-depth: 2 # Need at least 2 commits to analyze the latest
|
||||||
|
|
||||||
- name: Run Claude Analysis
|
- name: Run Claude Analysis
|
||||||
uses: anthropics/claude-code-action@beta
|
uses: anthropics/claude-code-action@v1-dev
|
||||||
with:
|
with:
|
||||||
mode: agent
|
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
override_prompt: |
|
prompt: |
|
||||||
Analyze the latest commit in this repository.
|
Analyze the latest commit in this repository.
|
||||||
|
|
||||||
${{ github.event.inputs.analysis_type == 'summarize-commit' && 'Task: Provide a clear, concise summary of what changed in the latest commit. Include the commit message, files changed, and the purpose of the changes.' || '' }}
|
${{ github.event.inputs.analysis_type == 'summarize-commit' && 'Task: Provide a clear, concise summary of what changed in the latest commit. Include the commit message, files changed, and the purpose of the changes.' || '' }}
|
||||||
|
|||||||
@@ -17,7 +17,6 @@ export function collectActionInputsPresence(): void {
|
|||||||
custom_instructions: "",
|
custom_instructions: "",
|
||||||
direct_prompt: "",
|
direct_prompt: "",
|
||||||
override_prompt: "",
|
override_prompt: "",
|
||||||
mcp_config: "",
|
|
||||||
additional_permissions: "",
|
additional_permissions: "",
|
||||||
claude_env: "",
|
claude_env: "",
|
||||||
settings: "",
|
settings: "",
|
||||||
|
|||||||
@@ -68,7 +68,7 @@ async function run() {
|
|||||||
});
|
});
|
||||||
|
|
||||||
// MCP config is handled by individual modes (tag/agent) and included in their claude_args output
|
// MCP config is handled by individual modes (tag/agent) and included in their claude_args output
|
||||||
|
|
||||||
// Expose the GitHub token (Claude App token) as an output
|
// Expose the GitHub token (Claude App token) as an output
|
||||||
core.setOutput("github_token", githubToken);
|
core.setOutput("github_token", githubToken);
|
||||||
|
|
||||||
|
|||||||
@@ -6,7 +6,7 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
import { $ } from "bun";
|
import { $ } from "bun";
|
||||||
import type { ParsedGitHubContext } from "../context";
|
import type { GitHubContext } from "../context";
|
||||||
import { GITHUB_SERVER_URL } from "../api/config";
|
import { GITHUB_SERVER_URL } from "../api/config";
|
||||||
|
|
||||||
type GitUser = {
|
type GitUser = {
|
||||||
@@ -16,7 +16,7 @@ type GitUser = {
|
|||||||
|
|
||||||
export async function configureGitAuth(
|
export async function configureGitAuth(
|
||||||
githubToken: string,
|
githubToken: string,
|
||||||
context: ParsedGitHubContext,
|
context: GitHubContext,
|
||||||
user: GitUser | null,
|
user: GitUser | null,
|
||||||
) {
|
) {
|
||||||
console.log("Configuring git authentication for non-signing mode");
|
console.log("Configuring git authentication for non-signing mode");
|
||||||
|
|||||||
@@ -3,8 +3,9 @@
|
|||||||
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
||||||
import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
|
import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
|
||||||
import { z } from "zod";
|
import { z } from "zod";
|
||||||
import { readFile } from "fs/promises";
|
import { readFile, stat } from "fs/promises";
|
||||||
import { join } from "path";
|
import { join } from "path";
|
||||||
|
import { constants } from "fs";
|
||||||
import fetch from "node-fetch";
|
import fetch from "node-fetch";
|
||||||
import { GITHUB_API_URL } from "../github/api/config";
|
import { GITHUB_API_URL } from "../github/api/config";
|
||||||
import { retryWithBackoff } from "../utils/retry";
|
import { retryWithBackoff } from "../utils/retry";
|
||||||
@@ -162,6 +163,34 @@ async function getOrCreateBranchRef(
|
|||||||
return baseSha;
|
return baseSha;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Get the appropriate Git file mode for a file
|
||||||
|
async function getFileMode(filePath: string): Promise<string> {
|
||||||
|
try {
|
||||||
|
const fileStat = await stat(filePath);
|
||||||
|
if (fileStat.isFile()) {
|
||||||
|
// Check if execute bit is set for user
|
||||||
|
if (fileStat.mode & constants.S_IXUSR) {
|
||||||
|
return "100755"; // Executable file
|
||||||
|
} else {
|
||||||
|
return "100644"; // Regular file
|
||||||
|
}
|
||||||
|
} else if (fileStat.isDirectory()) {
|
||||||
|
return "040000"; // Directory (tree)
|
||||||
|
} else if (fileStat.isSymbolicLink()) {
|
||||||
|
return "120000"; // Symbolic link
|
||||||
|
} else {
|
||||||
|
// Fallback for unknown file types
|
||||||
|
return "100644";
|
||||||
|
}
|
||||||
|
} catch (error) {
|
||||||
|
// If we can't stat the file, default to regular file
|
||||||
|
console.warn(
|
||||||
|
`Could not determine file mode for ${filePath}, using default: ${error}`,
|
||||||
|
);
|
||||||
|
return "100644";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// Commit files tool
|
// Commit files tool
|
||||||
server.tool(
|
server.tool(
|
||||||
"commit_files",
|
"commit_files",
|
||||||
@@ -223,6 +252,9 @@ server.tool(
|
|||||||
? filePath
|
? filePath
|
||||||
: join(REPO_DIR, filePath);
|
: join(REPO_DIR, filePath);
|
||||||
|
|
||||||
|
// Get the proper file mode based on file permissions
|
||||||
|
const fileMode = await getFileMode(fullPath);
|
||||||
|
|
||||||
// Check if file is binary (images, etc.)
|
// Check if file is binary (images, etc.)
|
||||||
const isBinaryFile =
|
const isBinaryFile =
|
||||||
/\.(png|jpg|jpeg|gif|webp|ico|pdf|zip|tar|gz|exe|bin|woff|woff2|ttf|eot)$/i.test(
|
/\.(png|jpg|jpeg|gif|webp|ico|pdf|zip|tar|gz|exe|bin|woff|woff2|ttf|eot)$/i.test(
|
||||||
@@ -261,7 +293,7 @@ server.tool(
|
|||||||
// Return tree entry with blob SHA
|
// Return tree entry with blob SHA
|
||||||
return {
|
return {
|
||||||
path: filePath,
|
path: filePath,
|
||||||
mode: "100644",
|
mode: fileMode,
|
||||||
type: "blob",
|
type: "blob",
|
||||||
sha: blobData.sha,
|
sha: blobData.sha,
|
||||||
};
|
};
|
||||||
@@ -270,7 +302,7 @@ server.tool(
|
|||||||
const content = await readFile(fullPath, "utf-8");
|
const content = await readFile(fullPath, "utf-8");
|
||||||
return {
|
return {
|
||||||
path: filePath,
|
path: filePath,
|
||||||
mode: "100644",
|
mode: fileMode,
|
||||||
type: "blob",
|
type: "blob",
|
||||||
content: content,
|
content: content,
|
||||||
};
|
};
|
||||||
@@ -353,15 +385,22 @@ server.tool(
|
|||||||
|
|
||||||
if (!updateRefResponse.ok) {
|
if (!updateRefResponse.ok) {
|
||||||
const errorText = await updateRefResponse.text();
|
const errorText = await updateRefResponse.text();
|
||||||
|
|
||||||
|
// Provide a more helpful error message for 403 permission errors
|
||||||
|
if (updateRefResponse.status === 403) {
|
||||||
|
const permissionError = new Error(
|
||||||
|
`Permission denied: Unable to push commits to branch '${branch}'. ` +
|
||||||
|
`Please rebase your branch from the main/master branch to allow Claude to commit.\n\n` +
|
||||||
|
`Original error: ${errorText}`,
|
||||||
|
);
|
||||||
|
throw permissionError;
|
||||||
|
}
|
||||||
|
|
||||||
|
// For other errors, use the original message
|
||||||
const error = new Error(
|
const error = new Error(
|
||||||
`Failed to update reference: ${updateRefResponse.status} - ${errorText}`,
|
`Failed to update reference: ${updateRefResponse.status} - ${errorText}`,
|
||||||
);
|
);
|
||||||
|
|
||||||
// Only retry on 403 errors - these are the intermittent failures we're targeting
|
|
||||||
if (updateRefResponse.status === 403) {
|
|
||||||
throw error;
|
|
||||||
}
|
|
||||||
|
|
||||||
// For non-403 errors, fail immediately without retry
|
// For non-403 errors, fail immediately without retry
|
||||||
console.error("Non-retryable error:", updateRefResponse.status);
|
console.error("Non-retryable error:", updateRefResponse.status);
|
||||||
throw error;
|
throw error;
|
||||||
@@ -559,16 +598,23 @@ server.tool(
|
|||||||
|
|
||||||
if (!updateRefResponse.ok) {
|
if (!updateRefResponse.ok) {
|
||||||
const errorText = await updateRefResponse.text();
|
const errorText = await updateRefResponse.text();
|
||||||
|
|
||||||
|
// Provide a more helpful error message for 403 permission errors
|
||||||
|
if (updateRefResponse.status === 403) {
|
||||||
|
console.log("Received 403 error, will retry...");
|
||||||
|
const permissionError = new Error(
|
||||||
|
`Permission denied: Unable to push commits to branch '${branch}'. ` +
|
||||||
|
`Please rebase your branch from the main/master branch to allow Claude to commit.\n\n` +
|
||||||
|
`Original error: ${errorText}`,
|
||||||
|
);
|
||||||
|
throw permissionError;
|
||||||
|
}
|
||||||
|
|
||||||
|
// For other errors, use the original message
|
||||||
const error = new Error(
|
const error = new Error(
|
||||||
`Failed to update reference: ${updateRefResponse.status} - ${errorText}`,
|
`Failed to update reference: ${updateRefResponse.status} - ${errorText}`,
|
||||||
);
|
);
|
||||||
|
|
||||||
// Only retry on 403 errors - these are the intermittent failures we're targeting
|
|
||||||
if (updateRefResponse.status === 403) {
|
|
||||||
console.log("Received 403 error, will retry...");
|
|
||||||
throw error;
|
|
||||||
}
|
|
||||||
|
|
||||||
// For non-403 errors, fail immediately without retry
|
// For non-403 errors, fail immediately without retry
|
||||||
console.error("Non-retryable error:", updateRefResponse.status);
|
console.error("Non-retryable error:", updateRefResponse.status);
|
||||||
throw error;
|
throw error;
|
||||||
|
|||||||
@@ -4,6 +4,7 @@ import type { Mode, ModeOptions, ModeResult } from "../types";
|
|||||||
import type { PreparedContext } from "../../create-prompt/types";
|
import type { PreparedContext } from "../../create-prompt/types";
|
||||||
import { prepareMcpConfig } from "../../mcp/install-mcp-server";
|
import { prepareMcpConfig } from "../../mcp/install-mcp-server";
|
||||||
import { parseAllowedTools } from "./parse-tools";
|
import { parseAllowedTools } from "./parse-tools";
|
||||||
|
import { configureGitAuth } from "../../github/operations/git-config";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Agent mode implementation.
|
* Agent mode implementation.
|
||||||
@@ -41,7 +42,30 @@ export const agentMode: Mode = {
|
|||||||
return false;
|
return false;
|
||||||
},
|
},
|
||||||
|
|
||||||
async prepare({ context, githubToken }: ModeOptions): Promise<ModeResult> {
|
async prepare({
|
||||||
|
context,
|
||||||
|
githubToken,
|
||||||
|
octokit,
|
||||||
|
}: ModeOptions): Promise<ModeResult> {
|
||||||
|
// Configure git authentication for agent mode (same as tag mode)
|
||||||
|
if (!context.inputs.useCommitSigning) {
|
||||||
|
try {
|
||||||
|
// Get the authenticated user (will be claude[bot] when using Claude App token)
|
||||||
|
const { data: authenticatedUser } =
|
||||||
|
await octokit.rest.users.getAuthenticated();
|
||||||
|
const user = {
|
||||||
|
login: authenticatedUser.login,
|
||||||
|
id: authenticatedUser.id,
|
||||||
|
};
|
||||||
|
|
||||||
|
// Use the shared git configuration function
|
||||||
|
await configureGitAuth(githubToken, context, user);
|
||||||
|
} catch (error) {
|
||||||
|
console.error("Failed to configure git authentication:", error);
|
||||||
|
// Continue anyway - git operations may still work with default config
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// Create prompt directory
|
// Create prompt directory
|
||||||
await mkdir(`${process.env.RUNNER_TEMP || "/tmp"}/claude-prompts`, {
|
await mkdir(`${process.env.RUNNER_TEMP || "/tmp"}/claude-prompts`, {
|
||||||
recursive: true,
|
recursive: true,
|
||||||
@@ -61,9 +85,17 @@ export const agentMode: Mode = {
|
|||||||
const userClaudeArgs = process.env.CLAUDE_ARGS || "";
|
const userClaudeArgs = process.env.CLAUDE_ARGS || "";
|
||||||
const allowedTools = parseAllowedTools(userClaudeArgs);
|
const allowedTools = parseAllowedTools(userClaudeArgs);
|
||||||
|
|
||||||
|
// Check for branch info from environment variables (useful for auto-fix workflows)
|
||||||
|
const claudeBranch = process.env.CLAUDE_BRANCH || undefined;
|
||||||
|
const baseBranch =
|
||||||
|
process.env.BASE_BRANCH || context.inputs.baseBranch || "main";
|
||||||
|
|
||||||
// Detect current branch from GitHub environment
|
// Detect current branch from GitHub environment
|
||||||
const currentBranch =
|
const currentBranch =
|
||||||
process.env.GITHUB_HEAD_REF || process.env.GITHUB_REF_NAME || "main";
|
claudeBranch ||
|
||||||
|
process.env.GITHUB_HEAD_REF ||
|
||||||
|
process.env.GITHUB_REF_NAME ||
|
||||||
|
"main";
|
||||||
|
|
||||||
// Get our GitHub MCP servers config
|
// Get our GitHub MCP servers config
|
||||||
const ourMcpConfig = await prepareMcpConfig({
|
const ourMcpConfig = await prepareMcpConfig({
|
||||||
@@ -71,7 +103,7 @@ export const agentMode: Mode = {
|
|||||||
owner: context.repository.owner,
|
owner: context.repository.owner,
|
||||||
repo: context.repository.repo,
|
repo: context.repository.repo,
|
||||||
branch: currentBranch,
|
branch: currentBranch,
|
||||||
baseBranch: context.inputs.baseBranch || "main",
|
baseBranch: baseBranch,
|
||||||
claudeCommentId: undefined, // No tracking comment in agent mode
|
claudeCommentId: undefined, // No tracking comment in agent mode
|
||||||
allowedTools,
|
allowedTools,
|
||||||
context,
|
context,
|
||||||
@@ -87,13 +119,6 @@ export const agentMode: Mode = {
|
|||||||
claudeArgs = `--mcp-config '${escapedOurConfig}'`;
|
claudeArgs = `--mcp-config '${escapedOurConfig}'`;
|
||||||
}
|
}
|
||||||
|
|
||||||
// Add user's MCP_CONFIG env var as separate --mcp-config
|
|
||||||
const userMcpConfig = process.env.MCP_CONFIG;
|
|
||||||
if (userMcpConfig?.trim()) {
|
|
||||||
const escapedUserConfig = userMcpConfig.replace(/'/g, "'\\''");
|
|
||||||
claudeArgs = `${claudeArgs} --mcp-config '${escapedUserConfig}'`.trim();
|
|
||||||
}
|
|
||||||
|
|
||||||
// Append user's claude_args (which may have more --mcp-config flags)
|
// Append user's claude_args (which may have more --mcp-config flags)
|
||||||
claudeArgs = `${claudeArgs} ${userClaudeArgs}`.trim();
|
claudeArgs = `${claudeArgs} ${userClaudeArgs}`.trim();
|
||||||
|
|
||||||
@@ -102,9 +127,9 @@ export const agentMode: Mode = {
|
|||||||
return {
|
return {
|
||||||
commentId: undefined,
|
commentId: undefined,
|
||||||
branchInfo: {
|
branchInfo: {
|
||||||
baseBranch: context.inputs.baseBranch || "main",
|
baseBranch: baseBranch,
|
||||||
currentBranch,
|
currentBranch: baseBranch, // Use base branch as current when creating new branch
|
||||||
claudeBranch: undefined,
|
claudeBranch: claudeBranch,
|
||||||
},
|
},
|
||||||
mcpConfig: ourMcpConfig,
|
mcpConfig: ourMcpConfig,
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -155,13 +155,6 @@ export const tagMode: Mode = {
|
|||||||
const escapedOurConfig = ourMcpConfig.replace(/'/g, "'\\''");
|
const escapedOurConfig = ourMcpConfig.replace(/'/g, "'\\''");
|
||||||
claudeArgs = `--mcp-config '${escapedOurConfig}'`;
|
claudeArgs = `--mcp-config '${escapedOurConfig}'`;
|
||||||
|
|
||||||
// Add user's MCP_CONFIG env var as separate --mcp-config
|
|
||||||
const userMcpConfig = process.env.MCP_CONFIG;
|
|
||||||
if (userMcpConfig?.trim()) {
|
|
||||||
const escapedUserConfig = userMcpConfig.replace(/'/g, "'\\''");
|
|
||||||
claudeArgs = `${claudeArgs} --mcp-config '${escapedUserConfig}'`;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Add required tools for tag mode
|
// Add required tools for tag mode
|
||||||
claudeArgs += ` --allowedTools "${tagModeTools.join(",")}"`;
|
claudeArgs += ` --allowedTools "${tagModeTools.join(",")}"`;
|
||||||
|
|
||||||
|
|||||||
@@ -38,4 +38,3 @@ export async function retryWithBackoff<T>(
|
|||||||
console.error(`Operation failed after ${maxAttempts} attempts`);
|
console.error(`Operation failed after ${maxAttempts} attempts`);
|
||||||
throw lastError;
|
throw lastError;
|
||||||
}
|
}
|
||||||
// Test change to trigger CI
|
|
||||||
|
|||||||
@@ -72,7 +72,7 @@ export const createMockAutomationContext = (
|
|||||||
|
|
||||||
const mergedInputs = overrides.inputs
|
const mergedInputs = overrides.inputs
|
||||||
? { ...defaultInputs, ...overrides.inputs }
|
? { ...defaultInputs, ...overrides.inputs }
|
||||||
: defaultInputs;
|
: { ...defaultInputs };
|
||||||
|
|
||||||
return { ...baseContext, ...overrides, inputs: mergedInputs };
|
return { ...baseContext, ...overrides, inputs: mergedInputs };
|
||||||
};
|
};
|
||||||
|
|||||||
Reference in New Issue
Block a user