mirror of
https://github.com/anthropics/claude-code-action.git
synced 2026-01-23 15:04:13 +08:00
Compare commits
51 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f4d737af0b | ||
|
|
29fe50368c | ||
|
|
8ad13bd20b | ||
|
|
7b914ae5c0 | ||
|
|
d4c09790f5 | ||
|
|
5033c581bb | ||
|
|
f8749bd14b | ||
|
|
f30f5eecfc | ||
|
|
fc4013af38 | ||
|
|
96524b7ffe | ||
|
|
fd20c95358 | ||
|
|
d808160c26 | ||
|
|
3eacedbeb7 | ||
|
|
f52f12eba5 | ||
|
|
4a85933f25 | ||
|
|
ba6edd55ef | ||
|
|
06461dddff | ||
|
|
c2a94eead0 | ||
|
|
1c0c3eaced | ||
|
|
23d2d6c6b4 | ||
|
|
e8bad57227 | ||
|
|
0a6d62601b | ||
|
|
777ffcbfc9 | ||
|
|
dc58efed33 | ||
|
|
e5437bfbc5 | ||
|
|
b2dd1006a0 | ||
|
|
ac1a3207f3 | ||
|
|
521d069da7 | ||
|
|
7e4b782d5f | ||
|
|
4fb0ef3be0 | ||
|
|
14ac8aa20e | ||
|
|
90d189f3ab | ||
|
|
9c09b26b2d | ||
|
|
2086c977a5 | ||
|
|
851ef5b84e | ||
|
|
1ce8153c18 | ||
|
|
00391ab25e | ||
|
|
426380f01b | ||
|
|
77f51d2905 | ||
|
|
7e5b42b197 | ||
|
|
1b7c7a77d3 | ||
|
|
bd70a3ef2b | ||
|
|
f4954b5256 | ||
|
|
93f8ab56c2 | ||
|
|
93028b410e | ||
|
|
838d4d9d25 | ||
|
|
7ed3b616d5 | ||
|
|
09ea2f00e1 | ||
|
|
455b943dd7 | ||
|
|
063d17ebb2 | ||
|
|
2e92922dd6 |
6
.github/workflows/ci.yml
vendored
6
.github/workflows/ci.yml
vendored
@@ -9,7 +9,7 @@ jobs:
|
|||||||
test:
|
test:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v5
|
||||||
|
|
||||||
- uses: oven-sh/setup-bun@v2
|
- uses: oven-sh/setup-bun@v2
|
||||||
with:
|
with:
|
||||||
@@ -24,7 +24,7 @@ jobs:
|
|||||||
prettier:
|
prettier:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v5
|
||||||
|
|
||||||
- uses: oven-sh/setup-bun@v1
|
- uses: oven-sh/setup-bun@v1
|
||||||
with:
|
with:
|
||||||
@@ -39,7 +39,7 @@ jobs:
|
|||||||
typecheck:
|
typecheck:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v5
|
||||||
|
|
||||||
- uses: oven-sh/setup-bun@v2
|
- uses: oven-sh/setup-bun@v2
|
||||||
with:
|
with:
|
||||||
|
|||||||
2
.github/workflows/claude-review.yml
vendored
2
.github/workflows/claude-review.yml
vendored
@@ -13,7 +13,7 @@ jobs:
|
|||||||
id-token: write
|
id-token: write
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout repository
|
- name: Checkout repository
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v5
|
||||||
with:
|
with:
|
||||||
fetch-depth: 1
|
fetch-depth: 1
|
||||||
|
|
||||||
|
|||||||
38
.github/workflows/claude-test.yml
vendored
38
.github/workflows/claude-test.yml
vendored
@@ -1,38 +0,0 @@
|
|||||||
# Test workflow for km-anthropic fork (v1-dev branch)
|
|
||||||
# This tests the fork implementation, not the main repo
|
|
||||||
name: Claude Code (Fork Test)
|
|
||||||
|
|
||||||
on:
|
|
||||||
issue_comment:
|
|
||||||
types: [created]
|
|
||||||
pull_request_review_comment:
|
|
||||||
types: [created]
|
|
||||||
issues:
|
|
||||||
types: [opened, assigned]
|
|
||||||
pull_request_review:
|
|
||||||
types: [submitted]
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
claude:
|
|
||||||
if: |
|
|
||||||
(github.event_name == 'issue_comment' && contains(github.event.comment.body, '@claude')) ||
|
|
||||||
(github.event_name == 'pull_request_review_comment' && contains(github.event.comment.body, '@claude')) ||
|
|
||||||
(github.event_name == 'pull_request_review' && contains(github.event.review.body, '@claude')) ||
|
|
||||||
(github.event_name == 'issues' && (
|
|
||||||
contains(github.event.issue.body, '@claude') ||
|
|
||||||
contains(github.event.issue.title, '@claude')
|
|
||||||
))
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
permissions:
|
|
||||||
contents: write
|
|
||||||
pull-requests: write
|
|
||||||
issues: write
|
|
||||||
id-token: write # Required for OIDC token exchange
|
|
||||||
steps:
|
|
||||||
- name: Checkout repository
|
|
||||||
uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- name: Run Claude Code
|
|
||||||
uses: km-anthropic/claude-code-action@v1-dev
|
|
||||||
with:
|
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
|
||||||
2
.github/workflows/claude.yml
vendored
2
.github/workflows/claude.yml
vendored
@@ -25,7 +25,7 @@ jobs:
|
|||||||
id-token: write
|
id-token: write
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout repository
|
- name: Checkout repository
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v5
|
||||||
with:
|
with:
|
||||||
fetch-depth: 1
|
fetch-depth: 1
|
||||||
|
|
||||||
|
|||||||
2
.github/workflows/issue-triage.yml
vendored
2
.github/workflows/issue-triage.yml
vendored
@@ -14,7 +14,7 @@ jobs:
|
|||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout repository
|
- name: Checkout repository
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v5
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
|
|
||||||
|
|||||||
6
.github/workflows/release.yml
vendored
6
.github/workflows/release.yml
vendored
@@ -19,7 +19,7 @@ jobs:
|
|||||||
next_version: ${{ steps.next_version.outputs.next_version }}
|
next_version: ${{ steps.next_version.outputs.next_version }}
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout code
|
- name: Checkout code
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v5
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
|
|
||||||
@@ -91,7 +91,7 @@ jobs:
|
|||||||
contents: write
|
contents: write
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout code
|
- name: Checkout code
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v5
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
|
|
||||||
@@ -116,7 +116,7 @@ jobs:
|
|||||||
environment: production
|
environment: production
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout base-action repo
|
- name: Checkout base-action repo
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v5
|
||||||
with:
|
with:
|
||||||
repository: anthropics/claude-code-base-action
|
repository: anthropics/claude-code-base-action
|
||||||
token: ${{ secrets.CLAUDE_CODE_BASE_ACTION_PAT }}
|
token: ${{ secrets.CLAUDE_CODE_BASE_ACTION_PAT }}
|
||||||
|
|||||||
4
.github/workflows/test-settings.yml
vendored
4
.github/workflows/test-settings.yml
vendored
@@ -67,7 +67,7 @@ jobs:
|
|||||||
uses: ./base-action
|
uses: ./base-action
|
||||||
with:
|
with:
|
||||||
prompt: |
|
prompt: |
|
||||||
Use Bash to echo "This should not work"
|
Run the command `echo $HOME` to check the home directory path
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
settings: |
|
settings: |
|
||||||
{
|
{
|
||||||
@@ -163,7 +163,7 @@ jobs:
|
|||||||
uses: ./base-action
|
uses: ./base-action
|
||||||
with:
|
with:
|
||||||
prompt: |
|
prompt: |
|
||||||
Use Bash to echo "This should not work from file"
|
Run the command `echo $HOME` to check the home directory path
|
||||||
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||||
settings: "test-settings.json"
|
settings: "test-settings.json"
|
||||||
|
|
||||||
|
|||||||
14
action.yml
14
action.yml
@@ -101,6 +101,14 @@ inputs:
|
|||||||
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."
|
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
|
required: false
|
||||||
default: ""
|
default: ""
|
||||||
|
plugins:
|
||||||
|
description: "Newline-separated list of Claude Code plugin names to install (e.g., 'code-review@claude-code-plugins\nfeature-dev@claude-code-plugins')"
|
||||||
|
required: false
|
||||||
|
default: ""
|
||||||
|
plugin_marketplaces:
|
||||||
|
description: "Newline-separated list of Claude Code plugin marketplace Git URLs to install from (e.g., 'https://github.com/user/marketplace1.git\nhttps://github.com/user/marketplace2.git')"
|
||||||
|
required: false
|
||||||
|
default: ""
|
||||||
|
|
||||||
outputs:
|
outputs:
|
||||||
execution_file:
|
execution_file:
|
||||||
@@ -177,7 +185,7 @@ runs:
|
|||||||
# Install Claude Code if no custom executable is provided
|
# Install Claude Code if no custom executable is provided
|
||||||
if [ -z "${{ inputs.path_to_claude_code_executable }}" ]; then
|
if [ -z "${{ inputs.path_to_claude_code_executable }}" ]; then
|
||||||
echo "Installing Claude Code..."
|
echo "Installing Claude Code..."
|
||||||
curl -fsSL https://claude.ai/install.sh | bash -s 1.0.112
|
curl -fsSL https://claude.ai/install.sh | bash -s 2.0.28
|
||||||
echo "$HOME/.local/bin" >> "$GITHUB_PATH"
|
echo "$HOME/.local/bin" >> "$GITHUB_PATH"
|
||||||
else
|
else
|
||||||
echo "Using custom Claude Code executable: ${{ inputs.path_to_claude_code_executable }}"
|
echo "Using custom Claude Code executable: ${{ inputs.path_to_claude_code_executable }}"
|
||||||
@@ -213,6 +221,8 @@ runs:
|
|||||||
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_CLAUDE_CODE_EXECUTABLE: ${{ inputs.path_to_claude_code_executable }}
|
||||||
INPUT_PATH_TO_BUN_EXECUTABLE: ${{ inputs.path_to_bun_executable }}
|
INPUT_PATH_TO_BUN_EXECUTABLE: ${{ inputs.path_to_bun_executable }}
|
||||||
|
INPUT_PLUGINS: ${{ inputs.plugins }}
|
||||||
|
INPUT_PLUGIN_MARKETPLACES: ${{ inputs.plugin_marketplaces }}
|
||||||
|
|
||||||
# Model configuration
|
# Model configuration
|
||||||
GITHUB_TOKEN: ${{ steps.prepare.outputs.GITHUB_TOKEN }}
|
GITHUB_TOKEN: ${{ steps.prepare.outputs.GITHUB_TOKEN }}
|
||||||
@@ -259,7 +269,7 @@ runs:
|
|||||||
GITHUB_EVENT_NAME: ${{ github.event_name }}
|
GITHUB_EVENT_NAME: ${{ github.event_name }}
|
||||||
TRIGGER_COMMENT_ID: ${{ github.event.comment.id }}
|
TRIGGER_COMMENT_ID: ${{ github.event.comment.id }}
|
||||||
CLAUDE_BRANCH: ${{ steps.prepare.outputs.CLAUDE_BRANCH }}
|
CLAUDE_BRANCH: ${{ steps.prepare.outputs.CLAUDE_BRANCH }}
|
||||||
IS_PR: ${{ github.event.issue.pull_request != null || github.event_name == 'pull_request_review_comment' }}
|
IS_PR: ${{ github.event.issue.pull_request != null || github.event_name == 'pull_request_target' || github.event_name == 'pull_request_review_comment' }}
|
||||||
BASE_BRANCH: ${{ steps.prepare.outputs.BASE_BRANCH }}
|
BASE_BRANCH: ${{ steps.prepare.outputs.BASE_BRANCH }}
|
||||||
CLAUDE_SUCCESS: ${{ steps.claude-code.outputs.conclusion == 'success' }}
|
CLAUDE_SUCCESS: ${{ steps.claude-code.outputs.conclusion == 'success' }}
|
||||||
OUTPUT_FILE: ${{ steps.claude-code.outputs.execution_file || '' }}
|
OUTPUT_FILE: ${{ steps.claude-code.outputs.execution_file || '' }}
|
||||||
|
|||||||
@@ -336,7 +336,7 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout code
|
- name: Checkout code
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v5
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
|
|
||||||
|
|||||||
@@ -55,6 +55,14 @@ inputs:
|
|||||||
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."
|
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
|
required: false
|
||||||
default: ""
|
default: ""
|
||||||
|
plugins:
|
||||||
|
description: "Newline-separated list of Claude Code plugin names to install (e.g., 'code-review@claude-code-plugins\nfeature-dev@claude-code-plugins')"
|
||||||
|
required: false
|
||||||
|
default: ""
|
||||||
|
plugin_marketplaces:
|
||||||
|
description: "Newline-separated list of Claude Code plugin marketplace Git URLs to install from (e.g., 'https://github.com/user/marketplace1.git\nhttps://github.com/user/marketplace2.git')"
|
||||||
|
required: false
|
||||||
|
default: ""
|
||||||
|
|
||||||
outputs:
|
outputs:
|
||||||
conclusion:
|
conclusion:
|
||||||
@@ -99,7 +107,7 @@ runs:
|
|||||||
run: |
|
run: |
|
||||||
if [ -z "${{ inputs.path_to_claude_code_executable }}" ]; then
|
if [ -z "${{ inputs.path_to_claude_code_executable }}" ]; then
|
||||||
echo "Installing Claude Code..."
|
echo "Installing Claude Code..."
|
||||||
curl -fsSL https://claude.ai/install.sh | bash -s 1.0.112
|
curl -fsSL https://claude.ai/install.sh | bash -s 2.0.28
|
||||||
else
|
else
|
||||||
echo "Using custom Claude Code executable: ${{ inputs.path_to_claude_code_executable }}"
|
echo "Using custom Claude Code executable: ${{ inputs.path_to_claude_code_executable }}"
|
||||||
# Add the directory containing the custom executable to PATH
|
# Add the directory containing the custom executable to PATH
|
||||||
@@ -126,6 +134,8 @@ runs:
|
|||||||
INPUT_CLAUDE_ARGS: ${{ inputs.claude_args }}
|
INPUT_CLAUDE_ARGS: ${{ inputs.claude_args }}
|
||||||
INPUT_PATH_TO_CLAUDE_CODE_EXECUTABLE: ${{ inputs.path_to_claude_code_executable }}
|
INPUT_PATH_TO_CLAUDE_CODE_EXECUTABLE: ${{ inputs.path_to_claude_code_executable }}
|
||||||
INPUT_PATH_TO_BUN_EXECUTABLE: ${{ inputs.path_to_bun_executable }}
|
INPUT_PATH_TO_BUN_EXECUTABLE: ${{ inputs.path_to_bun_executable }}
|
||||||
|
INPUT_PLUGINS: ${{ inputs.plugins }}
|
||||||
|
INPUT_PLUGIN_MARKETPLACES: ${{ inputs.plugin_marketplaces }}
|
||||||
|
|
||||||
# Provider configuration
|
# Provider configuration
|
||||||
ANTHROPIC_API_KEY: ${{ inputs.anthropic_api_key }}
|
ANTHROPIC_API_KEY: ${{ inputs.anthropic_api_key }}
|
||||||
|
|||||||
@@ -32,7 +32,7 @@ jobs:
|
|||||||
"--rm",
|
"--rm",
|
||||||
"-e",
|
"-e",
|
||||||
"GITHUB_PERSONAL_ACCESS_TOKEN",
|
"GITHUB_PERSONAL_ACCESS_TOKEN",
|
||||||
"ghcr.io/github/github-mcp-server:sha-7aced2b"
|
"ghcr.io/github/github-mcp-server:sha-23fa0dd"
|
||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"GITHUB_PERSONAL_ACCESS_TOKEN": "${{ secrets.GITHUB_TOKEN }}"
|
"GITHUB_PERSONAL_ACCESS_TOKEN": "${{ secrets.GITHUB_TOKEN }}"
|
||||||
|
|||||||
196
base-action/package-lock.json
generated
Normal file
196
base-action/package-lock.json
generated
Normal file
@@ -0,0 +1,196 @@
|
|||||||
|
{
|
||||||
|
"name": "@anthropic-ai/claude-code-base-action",
|
||||||
|
"version": "1.0.0",
|
||||||
|
"lockfileVersion": 3,
|
||||||
|
"requires": true,
|
||||||
|
"packages": {
|
||||||
|
"": {
|
||||||
|
"name": "@anthropic-ai/claude-code-base-action",
|
||||||
|
"version": "1.0.0",
|
||||||
|
"dependencies": {
|
||||||
|
"@actions/core": "^1.10.1",
|
||||||
|
"shell-quote": "^1.8.3"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"@types/bun": "^1.2.12",
|
||||||
|
"@types/node": "^20.0.0",
|
||||||
|
"@types/shell-quote": "^1.7.5",
|
||||||
|
"prettier": "3.5.3",
|
||||||
|
"typescript": "^5.8.3"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/@actions/core": {
|
||||||
|
"version": "1.11.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/@actions/core/-/core-1.11.1.tgz",
|
||||||
|
"integrity": "sha512-hXJCSrkwfA46Vd9Z3q4cpEpHB1rL5NG04+/rbqW9d3+CSvtB1tYe8UTpAlixa1vj0m/ULglfEK2UKxMGxCxv5A==",
|
||||||
|
"license": "MIT",
|
||||||
|
"dependencies": {
|
||||||
|
"@actions/exec": "^1.1.1",
|
||||||
|
"@actions/http-client": "^2.0.1"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/@actions/exec": {
|
||||||
|
"version": "1.1.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/@actions/exec/-/exec-1.1.1.tgz",
|
||||||
|
"integrity": "sha512-+sCcHHbVdk93a0XT19ECtO/gIXoxvdsgQLzb2fE2/5sIZmWQuluYyjPQtrtTHdU1YzTZ7bAPN4sITq2xi1679w==",
|
||||||
|
"license": "MIT",
|
||||||
|
"dependencies": {
|
||||||
|
"@actions/io": "^1.0.1"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/@actions/http-client": {
|
||||||
|
"version": "2.2.3",
|
||||||
|
"resolved": "https://registry.npmjs.org/@actions/http-client/-/http-client-2.2.3.tgz",
|
||||||
|
"integrity": "sha512-mx8hyJi/hjFvbPokCg4uRd4ZX78t+YyRPtnKWwIl+RzNaVuFpQHfmlGVfsKEJN8LwTCvL+DfVgAM04XaHkm6bA==",
|
||||||
|
"license": "MIT",
|
||||||
|
"dependencies": {
|
||||||
|
"tunnel": "^0.0.6",
|
||||||
|
"undici": "^5.25.4"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/@actions/io": {
|
||||||
|
"version": "1.1.3",
|
||||||
|
"resolved": "https://registry.npmjs.org/@actions/io/-/io-1.1.3.tgz",
|
||||||
|
"integrity": "sha512-wi9JjgKLYS7U/z8PPbco+PvTb/nRWjeoFlJ1Qer83k/3C5PHQi28hiVdeE2kHXmIL99mQFawx8qt/JPjZilJ8Q==",
|
||||||
|
"license": "MIT"
|
||||||
|
},
|
||||||
|
"node_modules/@fastify/busboy": {
|
||||||
|
"version": "2.1.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/@fastify/busboy/-/busboy-2.1.1.tgz",
|
||||||
|
"integrity": "sha512-vBZP4NlzfOlerQTnba4aqZoMhE/a9HY7HRqoOPaETQcSQuWEIyZMHGfVu6w9wGtGK5fED5qRs2DteVCjOH60sA==",
|
||||||
|
"license": "MIT",
|
||||||
|
"engines": {
|
||||||
|
"node": ">=14"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/@types/bun": {
|
||||||
|
"version": "1.3.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/@types/bun/-/bun-1.3.1.tgz",
|
||||||
|
"integrity": "sha512-4jNMk2/K9YJtfqwoAa28c8wK+T7nvJFOjxI4h/7sORWcypRNxBpr+TPNaCfVWq70tLCJsqoFwcf0oI0JU/fvMQ==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT",
|
||||||
|
"dependencies": {
|
||||||
|
"bun-types": "1.3.1"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/@types/node": {
|
||||||
|
"version": "20.19.23",
|
||||||
|
"resolved": "https://registry.npmjs.org/@types/node/-/node-20.19.23.tgz",
|
||||||
|
"integrity": "sha512-yIdlVVVHXpmqRhtyovZAcSy0MiPcYWGkoO4CGe/+jpP0hmNuihm4XhHbADpK++MsiLHP5MVlv+bcgdF99kSiFQ==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT",
|
||||||
|
"dependencies": {
|
||||||
|
"undici-types": "~6.21.0"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/@types/react": {
|
||||||
|
"version": "19.2.2",
|
||||||
|
"resolved": "https://registry.npmjs.org/@types/react/-/react-19.2.2.tgz",
|
||||||
|
"integrity": "sha512-6mDvHUFSjyT2B2yeNx2nUgMxh9LtOWvkhIU3uePn2I2oyNymUAX1NIsdgviM4CH+JSrp2D2hsMvJOkxY+0wNRA==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT",
|
||||||
|
"peer": true,
|
||||||
|
"dependencies": {
|
||||||
|
"csstype": "^3.0.2"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/@types/shell-quote": {
|
||||||
|
"version": "1.7.5",
|
||||||
|
"resolved": "https://registry.npmjs.org/@types/shell-quote/-/shell-quote-1.7.5.tgz",
|
||||||
|
"integrity": "sha512-+UE8GAGRPbJVQDdxi16dgadcBfQ+KG2vgZhV1+3A1XmHbmwcdwhCUwIdy+d3pAGrbvgRoVSjeI9vOWyq376Yzw==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT"
|
||||||
|
},
|
||||||
|
"node_modules/bun-types": {
|
||||||
|
"version": "1.3.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/bun-types/-/bun-types-1.3.1.tgz",
|
||||||
|
"integrity": "sha512-NMrcy7smratanWJ2mMXdpatalovtxVggkj11bScuWuiOoXTiKIu2eVS1/7qbyI/4yHedtsn175n4Sm4JcdHLXw==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT",
|
||||||
|
"dependencies": {
|
||||||
|
"@types/node": "*"
|
||||||
|
},
|
||||||
|
"peerDependencies": {
|
||||||
|
"@types/react": "^19"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/csstype": {
|
||||||
|
"version": "3.1.3",
|
||||||
|
"resolved": "https://registry.npmjs.org/csstype/-/csstype-3.1.3.tgz",
|
||||||
|
"integrity": "sha512-M1uQkMl8rQK/szD0LNhtqxIPLpimGm8sOBwU7lLnCpSbTyY3yeU1Vc7l4KT5zT4s/yOxHH5O7tIuuLOCnLADRw==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT",
|
||||||
|
"peer": true
|
||||||
|
},
|
||||||
|
"node_modules/prettier": {
|
||||||
|
"version": "3.5.3",
|
||||||
|
"resolved": "https://registry.npmjs.org/prettier/-/prettier-3.5.3.tgz",
|
||||||
|
"integrity": "sha512-QQtaxnoDJeAkDvDKWCLiwIXkTgRhwYDEQCghU9Z6q03iyek/rxRh/2lC3HB7P8sWT2xC/y5JDctPLBIGzHKbhw==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT",
|
||||||
|
"bin": {
|
||||||
|
"prettier": "bin/prettier.cjs"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">=14"
|
||||||
|
},
|
||||||
|
"funding": {
|
||||||
|
"url": "https://github.com/prettier/prettier?sponsor=1"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/shell-quote": {
|
||||||
|
"version": "1.8.3",
|
||||||
|
"resolved": "https://registry.npmjs.org/shell-quote/-/shell-quote-1.8.3.tgz",
|
||||||
|
"integrity": "sha512-ObmnIF4hXNg1BqhnHmgbDETF8dLPCggZWBjkQfhZpbszZnYur5DUljTcCHii5LC3J5E0yeO/1LIMyH+UvHQgyw==",
|
||||||
|
"license": "MIT",
|
||||||
|
"engines": {
|
||||||
|
"node": ">= 0.4"
|
||||||
|
},
|
||||||
|
"funding": {
|
||||||
|
"url": "https://github.com/sponsors/ljharb"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/tunnel": {
|
||||||
|
"version": "0.0.6",
|
||||||
|
"resolved": "https://registry.npmjs.org/tunnel/-/tunnel-0.0.6.tgz",
|
||||||
|
"integrity": "sha512-1h/Lnq9yajKY2PEbBadPXj3VxsDDu844OnaAo52UVmIzIvwwtBPIuNvkjuzBlTWpfJyUbG3ez0KSBibQkj4ojg==",
|
||||||
|
"license": "MIT",
|
||||||
|
"engines": {
|
||||||
|
"node": ">=0.6.11 <=0.7.0 || >=0.7.3"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/typescript": {
|
||||||
|
"version": "5.9.3",
|
||||||
|
"resolved": "https://registry.npmjs.org/typescript/-/typescript-5.9.3.tgz",
|
||||||
|
"integrity": "sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "Apache-2.0",
|
||||||
|
"bin": {
|
||||||
|
"tsc": "bin/tsc",
|
||||||
|
"tsserver": "bin/tsserver"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">=14.17"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/undici": {
|
||||||
|
"version": "5.29.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/undici/-/undici-5.29.0.tgz",
|
||||||
|
"integrity": "sha512-raqeBD6NQK4SkWhQzeYKd1KmIG6dllBOTt55Rmkt4HtI9mwdWtJljnrXjAFUBLTSN67HWrOIZ3EPF4kjUw80Bg==",
|
||||||
|
"license": "MIT",
|
||||||
|
"dependencies": {
|
||||||
|
"@fastify/busboy": "^2.0.0"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">=14.0"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/undici-types": {
|
||||||
|
"version": "6.21.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/undici-types/-/undici-types-6.21.0.tgz",
|
||||||
|
"integrity": "sha512-iwDZqg0QAGrg9Rav5H4n0M64c3mkR59cJ6wQp+7C4nI0gsmExaedaYLNO44eT4AtBBwjbTiGPMlt2Md0T9H9JQ==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -5,6 +5,7 @@ import { preparePrompt } from "./prepare-prompt";
|
|||||||
import { runClaude } from "./run-claude";
|
import { runClaude } from "./run-claude";
|
||||||
import { setupClaudeCodeSettings } from "./setup-claude-code-settings";
|
import { setupClaudeCodeSettings } from "./setup-claude-code-settings";
|
||||||
import { validateEnvironmentVariables } from "./validate-env";
|
import { validateEnvironmentVariables } from "./validate-env";
|
||||||
|
import { installPlugins } from "./install-plugins";
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
try {
|
try {
|
||||||
@@ -15,6 +16,13 @@ async function run() {
|
|||||||
undefined, // homeDir
|
undefined, // homeDir
|
||||||
);
|
);
|
||||||
|
|
||||||
|
// Install Claude Code plugins if specified
|
||||||
|
await installPlugins(
|
||||||
|
process.env.INPUT_PLUGIN_MARKETPLACES,
|
||||||
|
process.env.INPUT_PLUGINS,
|
||||||
|
process.env.INPUT_PATH_TO_CLAUDE_CODE_EXECUTABLE,
|
||||||
|
);
|
||||||
|
|
||||||
const promptConfig = await preparePrompt({
|
const promptConfig = await preparePrompt({
|
||||||
prompt: process.env.INPUT_PROMPT || "",
|
prompt: process.env.INPUT_PROMPT || "",
|
||||||
promptFile: process.env.INPUT_PROMPT_FILE || "",
|
promptFile: process.env.INPUT_PROMPT_FILE || "",
|
||||||
|
|||||||
222
base-action/src/install-plugins.ts
Normal file
222
base-action/src/install-plugins.ts
Normal file
@@ -0,0 +1,222 @@
|
|||||||
|
import { spawn, ChildProcess } from "child_process";
|
||||||
|
|
||||||
|
const PLUGIN_NAME_REGEX = /^[@a-zA-Z0-9_\-\/\.]+$/;
|
||||||
|
const MAX_PLUGIN_NAME_LENGTH = 512;
|
||||||
|
const PATH_TRAVERSAL_REGEX =
|
||||||
|
/\.\.\/|\/\.\.|\.\/|\/\.|(?:^|\/)\.\.$|(?:^|\/)\.$|\.\.(?![0-9])/;
|
||||||
|
const MARKETPLACE_URL_REGEX =
|
||||||
|
/^https:\/\/[a-zA-Z0-9\-._~:/?#[\]@!$&'()*+,;=%]+\.git$/;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Validates a marketplace URL for security issues
|
||||||
|
* @param url - The marketplace URL to validate
|
||||||
|
* @throws {Error} If the URL is invalid
|
||||||
|
*/
|
||||||
|
function validateMarketplaceUrl(url: string): void {
|
||||||
|
const normalized = url.trim();
|
||||||
|
|
||||||
|
if (!normalized) {
|
||||||
|
throw new Error("Marketplace URL cannot be empty");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!MARKETPLACE_URL_REGEX.test(normalized)) {
|
||||||
|
throw new Error(`Invalid marketplace URL format: ${url}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Additional check for valid URL structure
|
||||||
|
try {
|
||||||
|
new URL(normalized);
|
||||||
|
} catch {
|
||||||
|
throw new Error(`Invalid marketplace URL: ${url}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Validates a plugin name for security issues
|
||||||
|
* @param pluginName - The plugin name to validate
|
||||||
|
* @throws {Error} If the plugin name is invalid
|
||||||
|
*/
|
||||||
|
function validatePluginName(pluginName: string): void {
|
||||||
|
// Normalize Unicode to prevent homoglyph attacks (e.g., fullwidth dots, Unicode slashes)
|
||||||
|
const normalized = pluginName.normalize("NFC");
|
||||||
|
|
||||||
|
if (normalized.length > MAX_PLUGIN_NAME_LENGTH) {
|
||||||
|
throw new Error(`Plugin name too long: ${normalized.substring(0, 50)}...`);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!PLUGIN_NAME_REGEX.test(normalized)) {
|
||||||
|
throw new Error(`Invalid plugin name format: ${pluginName}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Prevent path traversal attacks with single efficient regex check
|
||||||
|
if (PATH_TRAVERSAL_REGEX.test(normalized)) {
|
||||||
|
throw new Error(`Invalid plugin name format: ${pluginName}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Parse a newline-separated list of marketplace URLs and return an array of validated URLs
|
||||||
|
* @param marketplaces - Newline-separated list of marketplace Git URLs
|
||||||
|
* @returns Array of validated marketplace URLs (empty array if none provided)
|
||||||
|
*/
|
||||||
|
function parseMarketplaces(marketplaces?: string): string[] {
|
||||||
|
const trimmed = marketplaces?.trim();
|
||||||
|
|
||||||
|
if (!trimmed) {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
|
||||||
|
// Split by newline and process each URL
|
||||||
|
return trimmed
|
||||||
|
.split("\n")
|
||||||
|
.map((url) => url.trim())
|
||||||
|
.filter((url) => {
|
||||||
|
if (url.length === 0) return false;
|
||||||
|
|
||||||
|
validateMarketplaceUrl(url);
|
||||||
|
return true;
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Parse a newline-separated list of plugin names and return an array of trimmed, non-empty plugin names
|
||||||
|
* Validates plugin names to prevent command injection and path traversal attacks
|
||||||
|
* Allows: letters, numbers, @, -, _, /, . (common npm/scoped package characters)
|
||||||
|
* Disallows: path traversal (../, ./), shell metacharacters, and consecutive dots
|
||||||
|
* @param plugins - Newline-separated list of plugin names, or undefined/empty to return empty array
|
||||||
|
* @returns Array of validated plugin names (empty array if none provided)
|
||||||
|
* @throws {Error} If any plugin name fails validation
|
||||||
|
*/
|
||||||
|
function parsePlugins(plugins?: string): string[] {
|
||||||
|
const trimmedPlugins = plugins?.trim();
|
||||||
|
|
||||||
|
if (!trimmedPlugins) {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
|
||||||
|
// Split by newline and process each plugin
|
||||||
|
return trimmedPlugins
|
||||||
|
.split("\n")
|
||||||
|
.map((p) => p.trim())
|
||||||
|
.filter((p) => {
|
||||||
|
if (p.length === 0) return false;
|
||||||
|
|
||||||
|
validatePluginName(p);
|
||||||
|
return true;
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Executes a Claude Code CLI command with proper error handling
|
||||||
|
* @param claudeExecutable - Path to the Claude executable
|
||||||
|
* @param args - Command arguments to pass to the executable
|
||||||
|
* @param errorContext - Context string for error messages (e.g., "Failed to install plugin 'foo'")
|
||||||
|
* @returns Promise that resolves when the command completes successfully
|
||||||
|
* @throws {Error} If the command fails to execute
|
||||||
|
*/
|
||||||
|
async function executeClaudeCommand(
|
||||||
|
claudeExecutable: string,
|
||||||
|
args: string[],
|
||||||
|
errorContext: string,
|
||||||
|
): Promise<void> {
|
||||||
|
return new Promise((resolve, reject) => {
|
||||||
|
const childProcess: ChildProcess = spawn(claudeExecutable, args, {
|
||||||
|
stdio: "inherit",
|
||||||
|
});
|
||||||
|
|
||||||
|
childProcess.on("close", (code: number | null) => {
|
||||||
|
if (code === 0) {
|
||||||
|
resolve();
|
||||||
|
} else if (code === null) {
|
||||||
|
reject(new Error(`${errorContext}: process terminated by signal`));
|
||||||
|
} else {
|
||||||
|
reject(new Error(`${errorContext} (exit code: ${code})`));
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
childProcess.on("error", (err: Error) => {
|
||||||
|
reject(new Error(`${errorContext}: ${err.message}`));
|
||||||
|
});
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Installs a single Claude Code plugin
|
||||||
|
* @param pluginName - The name of the plugin to install
|
||||||
|
* @param claudeExecutable - Path to the Claude executable
|
||||||
|
* @returns Promise that resolves when the plugin is installed successfully
|
||||||
|
* @throws {Error} If the plugin installation fails
|
||||||
|
*/
|
||||||
|
async function installPlugin(
|
||||||
|
pluginName: string,
|
||||||
|
claudeExecutable: string,
|
||||||
|
): Promise<void> {
|
||||||
|
console.log(`Installing plugin: ${pluginName}`);
|
||||||
|
|
||||||
|
return executeClaudeCommand(
|
||||||
|
claudeExecutable,
|
||||||
|
["plugin", "install", pluginName],
|
||||||
|
`Failed to install plugin '${pluginName}'`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Adds a Claude Code plugin marketplace
|
||||||
|
* @param claudeExecutable - Path to the Claude executable
|
||||||
|
* @param marketplaceUrl - The marketplace Git URL to add
|
||||||
|
* @returns Promise that resolves when the marketplace add command completes
|
||||||
|
* @throws {Error} If the command fails to execute
|
||||||
|
*/
|
||||||
|
async function addMarketplace(
|
||||||
|
claudeExecutable: string,
|
||||||
|
marketplaceUrl: string,
|
||||||
|
): Promise<void> {
|
||||||
|
console.log(`Adding marketplace: ${marketplaceUrl}`);
|
||||||
|
|
||||||
|
return executeClaudeCommand(
|
||||||
|
claudeExecutable,
|
||||||
|
["plugin", "marketplace", "add", marketplaceUrl],
|
||||||
|
`Failed to add marketplace '${marketplaceUrl}'`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Installs Claude Code plugins from a newline-separated list
|
||||||
|
* @param marketplacesInput - Newline-separated list of marketplace Git URLs
|
||||||
|
* @param pluginsInput - Newline-separated list of plugin names
|
||||||
|
* @param claudeExecutable - Path to the Claude executable (defaults to "claude")
|
||||||
|
* @returns Promise that resolves when all plugins are installed
|
||||||
|
* @throws {Error} If any plugin fails validation or installation (stops on first error)
|
||||||
|
*/
|
||||||
|
export async function installPlugins(
|
||||||
|
marketplacesInput?: string,
|
||||||
|
pluginsInput?: string,
|
||||||
|
claudeExecutable?: string,
|
||||||
|
): Promise<void> {
|
||||||
|
// Resolve executable path with explicit fallback
|
||||||
|
const resolvedExecutable = claudeExecutable || "claude";
|
||||||
|
|
||||||
|
// Parse and add all marketplaces before installing plugins
|
||||||
|
const marketplaces = parseMarketplaces(marketplacesInput);
|
||||||
|
|
||||||
|
if (marketplaces.length > 0) {
|
||||||
|
console.log(`Adding ${marketplaces.length} marketplace(s)...`);
|
||||||
|
for (const marketplace of marketplaces) {
|
||||||
|
await addMarketplace(resolvedExecutable, marketplace);
|
||||||
|
console.log(`✓ Successfully added marketplace: ${marketplace}`);
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
console.log("No marketplaces specified, skipping marketplace setup");
|
||||||
|
}
|
||||||
|
|
||||||
|
const plugins = parsePlugins(pluginsInput);
|
||||||
|
if (plugins.length > 0) {
|
||||||
|
console.log(`Installing ${plugins.length} plugin(s)...`);
|
||||||
|
for (const plugin of plugins) {
|
||||||
|
await installPlugin(plugin, resolvedExecutable);
|
||||||
|
console.log(`✓ Successfully installed: ${plugin}`);
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
console.log("No plugins specified, skipping plugins installation");
|
||||||
|
}
|
||||||
|
}
|
||||||
599
base-action/test/install-plugins.test.ts
Normal file
599
base-action/test/install-plugins.test.ts
Normal file
@@ -0,0 +1,599 @@
|
|||||||
|
#!/usr/bin/env bun
|
||||||
|
|
||||||
|
import { describe, test, expect, mock, spyOn, afterEach } from "bun:test";
|
||||||
|
import { installPlugins } from "../src/install-plugins";
|
||||||
|
import * as childProcess from "child_process";
|
||||||
|
|
||||||
|
describe("installPlugins", () => {
|
||||||
|
let spawnSpy: ReturnType<typeof spyOn> | undefined;
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
// Restore original spawn after each test
|
||||||
|
if (spawnSpy) {
|
||||||
|
spawnSpy.mockRestore();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
function createMockSpawn(
|
||||||
|
exitCode: number | null = 0,
|
||||||
|
shouldError: boolean = false,
|
||||||
|
) {
|
||||||
|
const mockProcess = {
|
||||||
|
on: mock((event: string, handler: Function) => {
|
||||||
|
if (event === "close" && !shouldError) {
|
||||||
|
// Simulate successful close
|
||||||
|
setTimeout(() => handler(exitCode), 0);
|
||||||
|
} else if (event === "error" && shouldError) {
|
||||||
|
// Simulate error
|
||||||
|
setTimeout(() => handler(new Error("spawn error")), 0);
|
||||||
|
}
|
||||||
|
return mockProcess;
|
||||||
|
}),
|
||||||
|
};
|
||||||
|
|
||||||
|
spawnSpy = spyOn(childProcess, "spawn").mockImplementation(
|
||||||
|
() => mockProcess as any,
|
||||||
|
);
|
||||||
|
return spawnSpy;
|
||||||
|
}
|
||||||
|
|
||||||
|
test("should not call spawn when no plugins are specified", async () => {
|
||||||
|
const spy = createMockSpawn();
|
||||||
|
await installPlugins(undefined, "");
|
||||||
|
expect(spy).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should not call spawn when plugins is undefined", async () => {
|
||||||
|
const spy = createMockSpawn();
|
||||||
|
await installPlugins(undefined, undefined);
|
||||||
|
expect(spy).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should not call spawn when plugins is only whitespace", async () => {
|
||||||
|
const spy = createMockSpawn();
|
||||||
|
await installPlugins(undefined, " ");
|
||||||
|
expect(spy).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should install a single plugin with default executable", async () => {
|
||||||
|
const spy = createMockSpawn();
|
||||||
|
await installPlugins(undefined, "test-plugin");
|
||||||
|
|
||||||
|
expect(spy).toHaveBeenCalledTimes(1);
|
||||||
|
// Only call: install plugin (no marketplace without explicit marketplace input)
|
||||||
|
expect(spy).toHaveBeenNthCalledWith(
|
||||||
|
1,
|
||||||
|
"claude",
|
||||||
|
["plugin", "install", "test-plugin"],
|
||||||
|
{ stdio: "inherit" },
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should install multiple plugins sequentially", async () => {
|
||||||
|
const spy = createMockSpawn();
|
||||||
|
await installPlugins(undefined, "plugin1\nplugin2\nplugin3");
|
||||||
|
|
||||||
|
expect(spy).toHaveBeenCalledTimes(3);
|
||||||
|
// Install plugins (no marketplace without explicit marketplace input)
|
||||||
|
expect(spy).toHaveBeenNthCalledWith(
|
||||||
|
1,
|
||||||
|
"claude",
|
||||||
|
["plugin", "install", "plugin1"],
|
||||||
|
{ stdio: "inherit" },
|
||||||
|
);
|
||||||
|
expect(spy).toHaveBeenNthCalledWith(
|
||||||
|
2,
|
||||||
|
"claude",
|
||||||
|
["plugin", "install", "plugin2"],
|
||||||
|
{ stdio: "inherit" },
|
||||||
|
);
|
||||||
|
expect(spy).toHaveBeenNthCalledWith(
|
||||||
|
3,
|
||||||
|
"claude",
|
||||||
|
["plugin", "install", "plugin3"],
|
||||||
|
{ stdio: "inherit" },
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should use custom claude executable path when provided", async () => {
|
||||||
|
const spy = createMockSpawn();
|
||||||
|
await installPlugins(undefined, "test-plugin", "/custom/path/to/claude");
|
||||||
|
|
||||||
|
expect(spy).toHaveBeenCalledTimes(1);
|
||||||
|
// Only call: install plugin (no marketplace without explicit marketplace input)
|
||||||
|
expect(spy).toHaveBeenNthCalledWith(
|
||||||
|
1,
|
||||||
|
"/custom/path/to/claude",
|
||||||
|
["plugin", "install", "test-plugin"],
|
||||||
|
{ stdio: "inherit" },
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should trim whitespace from plugin names before installation", async () => {
|
||||||
|
const spy = createMockSpawn();
|
||||||
|
await installPlugins(undefined, " plugin1 \n plugin2 ");
|
||||||
|
|
||||||
|
expect(spy).toHaveBeenCalledTimes(2);
|
||||||
|
// Install plugins (no marketplace without explicit marketplace input)
|
||||||
|
expect(spy).toHaveBeenNthCalledWith(
|
||||||
|
1,
|
||||||
|
"claude",
|
||||||
|
["plugin", "install", "plugin1"],
|
||||||
|
{ stdio: "inherit" },
|
||||||
|
);
|
||||||
|
expect(spy).toHaveBeenNthCalledWith(
|
||||||
|
2,
|
||||||
|
"claude",
|
||||||
|
["plugin", "install", "plugin2"],
|
||||||
|
{ stdio: "inherit" },
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should skip empty entries in plugin list", async () => {
|
||||||
|
const spy = createMockSpawn();
|
||||||
|
await installPlugins(undefined, "plugin1\n\nplugin2");
|
||||||
|
|
||||||
|
expect(spy).toHaveBeenCalledTimes(2);
|
||||||
|
// Install plugins (no marketplace without explicit marketplace input)
|
||||||
|
expect(spy).toHaveBeenNthCalledWith(
|
||||||
|
1,
|
||||||
|
"claude",
|
||||||
|
["plugin", "install", "plugin1"],
|
||||||
|
{ stdio: "inherit" },
|
||||||
|
);
|
||||||
|
expect(spy).toHaveBeenNthCalledWith(
|
||||||
|
2,
|
||||||
|
"claude",
|
||||||
|
["plugin", "install", "plugin2"],
|
||||||
|
{ stdio: "inherit" },
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should handle plugin installation error and throw", async () => {
|
||||||
|
createMockSpawn(1, false); // Exit code 1
|
||||||
|
|
||||||
|
await expect(installPlugins(undefined, "failing-plugin")).rejects.toThrow(
|
||||||
|
"Failed to install plugin 'failing-plugin' (exit code: 1)",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should handle null exit code (process terminated by signal)", async () => {
|
||||||
|
createMockSpawn(null, false); // Exit code null (terminated by signal)
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
installPlugins(undefined, "terminated-plugin"),
|
||||||
|
).rejects.toThrow(
|
||||||
|
"Failed to install plugin 'terminated-plugin': process terminated by signal",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should stop installation on first error", async () => {
|
||||||
|
const spy = createMockSpawn(1, false); // Exit code 1
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
installPlugins(undefined, "plugin1\nplugin2\nplugin3"),
|
||||||
|
).rejects.toThrow("Failed to install plugin 'plugin1' (exit code: 1)");
|
||||||
|
|
||||||
|
// Should only try to install first plugin before failing
|
||||||
|
expect(spy).toHaveBeenCalledTimes(1);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should handle plugins with special characters in names", async () => {
|
||||||
|
const spy = createMockSpawn();
|
||||||
|
await installPlugins(undefined, "org/plugin-name\n@scope/plugin");
|
||||||
|
|
||||||
|
expect(spy).toHaveBeenCalledTimes(2);
|
||||||
|
// Install plugins (no marketplace without explicit marketplace input)
|
||||||
|
expect(spy).toHaveBeenNthCalledWith(
|
||||||
|
1,
|
||||||
|
"claude",
|
||||||
|
["plugin", "install", "org/plugin-name"],
|
||||||
|
{ stdio: "inherit" },
|
||||||
|
);
|
||||||
|
expect(spy).toHaveBeenNthCalledWith(
|
||||||
|
2,
|
||||||
|
"claude",
|
||||||
|
["plugin", "install", "@scope/plugin"],
|
||||||
|
{ stdio: "inherit" },
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should handle spawn errors", async () => {
|
||||||
|
createMockSpawn(0, true); // Trigger error event
|
||||||
|
|
||||||
|
await expect(installPlugins(undefined, "test-plugin")).rejects.toThrow(
|
||||||
|
"Failed to install plugin 'test-plugin': spawn error",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should install plugins with custom executable and multiple plugins", async () => {
|
||||||
|
const spy = createMockSpawn();
|
||||||
|
await installPlugins(
|
||||||
|
undefined,
|
||||||
|
"plugin-a\nplugin-b",
|
||||||
|
"/usr/local/bin/claude-custom",
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(spy).toHaveBeenCalledTimes(2);
|
||||||
|
// Install plugins (no marketplace without explicit marketplace input)
|
||||||
|
expect(spy).toHaveBeenNthCalledWith(
|
||||||
|
1,
|
||||||
|
"/usr/local/bin/claude-custom",
|
||||||
|
["plugin", "install", "plugin-a"],
|
||||||
|
{ stdio: "inherit" },
|
||||||
|
);
|
||||||
|
expect(spy).toHaveBeenNthCalledWith(
|
||||||
|
2,
|
||||||
|
"/usr/local/bin/claude-custom",
|
||||||
|
["plugin", "install", "plugin-b"],
|
||||||
|
{ stdio: "inherit" },
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should reject plugin names with command injection attempts", async () => {
|
||||||
|
const spy = createMockSpawn();
|
||||||
|
|
||||||
|
// Should throw due to invalid characters (semicolon and spaces)
|
||||||
|
await expect(
|
||||||
|
installPlugins(undefined, "plugin-name; rm -rf /"),
|
||||||
|
).rejects.toThrow("Invalid plugin name format");
|
||||||
|
|
||||||
|
// Mock should never be called because validation fails first
|
||||||
|
expect(spy).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should reject plugin names with path traversal using ../", async () => {
|
||||||
|
const spy = createMockSpawn();
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
installPlugins(undefined, "../../../malicious-plugin"),
|
||||||
|
).rejects.toThrow("Invalid plugin name format");
|
||||||
|
|
||||||
|
expect(spy).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should reject plugin names with path traversal using ./", async () => {
|
||||||
|
const spy = createMockSpawn();
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
installPlugins(undefined, "./../../@scope/package"),
|
||||||
|
).rejects.toThrow("Invalid plugin name format");
|
||||||
|
|
||||||
|
expect(spy).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should reject plugin names with consecutive dots", async () => {
|
||||||
|
const spy = createMockSpawn();
|
||||||
|
|
||||||
|
await expect(installPlugins(undefined, ".../.../package")).rejects.toThrow(
|
||||||
|
"Invalid plugin name format",
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(spy).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should reject plugin names with hidden path traversal", async () => {
|
||||||
|
const spy = createMockSpawn();
|
||||||
|
|
||||||
|
await expect(installPlugins(undefined, "package/../other")).rejects.toThrow(
|
||||||
|
"Invalid plugin name format",
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(spy).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should accept plugin names with single dots in version numbers", async () => {
|
||||||
|
const spy = createMockSpawn();
|
||||||
|
await installPlugins(undefined, "plugin-v1.0.2");
|
||||||
|
|
||||||
|
expect(spy).toHaveBeenCalledTimes(1);
|
||||||
|
// Only call: install plugin (no marketplace without explicit marketplace input)
|
||||||
|
expect(spy).toHaveBeenNthCalledWith(
|
||||||
|
1,
|
||||||
|
"claude",
|
||||||
|
["plugin", "install", "plugin-v1.0.2"],
|
||||||
|
{ stdio: "inherit" },
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should accept plugin names with multiple dots in semantic versions", async () => {
|
||||||
|
const spy = createMockSpawn();
|
||||||
|
await installPlugins(undefined, "@scope/plugin-v1.0.0-beta.1");
|
||||||
|
|
||||||
|
expect(spy).toHaveBeenCalledTimes(1);
|
||||||
|
// Only call: install plugin (no marketplace without explicit marketplace input)
|
||||||
|
expect(spy).toHaveBeenNthCalledWith(
|
||||||
|
1,
|
||||||
|
"claude",
|
||||||
|
["plugin", "install", "@scope/plugin-v1.0.0-beta.1"],
|
||||||
|
{ stdio: "inherit" },
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should reject Unicode homoglyph path traversal attempts", async () => {
|
||||||
|
const spy = createMockSpawn();
|
||||||
|
|
||||||
|
// Using fullwidth dots (U+FF0E) and fullwidth solidus (U+FF0F)
|
||||||
|
await expect(installPlugins(undefined, "../malicious")).rejects.toThrow(
|
||||||
|
"Invalid plugin name format",
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(spy).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should reject path traversal at end of path", async () => {
|
||||||
|
const spy = createMockSpawn();
|
||||||
|
|
||||||
|
await expect(installPlugins(undefined, "package/..")).rejects.toThrow(
|
||||||
|
"Invalid plugin name format",
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(spy).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should reject single dot directory reference", async () => {
|
||||||
|
const spy = createMockSpawn();
|
||||||
|
|
||||||
|
await expect(installPlugins(undefined, "package/.")).rejects.toThrow(
|
||||||
|
"Invalid plugin name format",
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(spy).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should reject path traversal in middle of path", async () => {
|
||||||
|
const spy = createMockSpawn();
|
||||||
|
|
||||||
|
await expect(installPlugins(undefined, "package/../other")).rejects.toThrow(
|
||||||
|
"Invalid plugin name format",
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(spy).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
|
||||||
|
// Marketplace functionality tests
|
||||||
|
test("should add a single marketplace before installing plugins", async () => {
|
||||||
|
const spy = createMockSpawn();
|
||||||
|
await installPlugins(
|
||||||
|
"https://github.com/user/marketplace.git",
|
||||||
|
"test-plugin",
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(spy).toHaveBeenCalledTimes(2);
|
||||||
|
// First call: add marketplace
|
||||||
|
expect(spy).toHaveBeenNthCalledWith(
|
||||||
|
1,
|
||||||
|
"claude",
|
||||||
|
[
|
||||||
|
"plugin",
|
||||||
|
"marketplace",
|
||||||
|
"add",
|
||||||
|
"https://github.com/user/marketplace.git",
|
||||||
|
],
|
||||||
|
{ stdio: "inherit" },
|
||||||
|
);
|
||||||
|
// Second call: install plugin
|
||||||
|
expect(spy).toHaveBeenNthCalledWith(
|
||||||
|
2,
|
||||||
|
"claude",
|
||||||
|
["plugin", "install", "test-plugin"],
|
||||||
|
{ stdio: "inherit" },
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should add multiple marketplaces with newline separation", async () => {
|
||||||
|
const spy = createMockSpawn();
|
||||||
|
await installPlugins(
|
||||||
|
"https://github.com/user/m1.git\nhttps://github.com/user/m2.git",
|
||||||
|
"test-plugin",
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(spy).toHaveBeenCalledTimes(3); // 2 marketplaces + 1 plugin
|
||||||
|
// First two calls: add marketplaces
|
||||||
|
expect(spy).toHaveBeenNthCalledWith(
|
||||||
|
1,
|
||||||
|
"claude",
|
||||||
|
["plugin", "marketplace", "add", "https://github.com/user/m1.git"],
|
||||||
|
{ stdio: "inherit" },
|
||||||
|
);
|
||||||
|
expect(spy).toHaveBeenNthCalledWith(
|
||||||
|
2,
|
||||||
|
"claude",
|
||||||
|
["plugin", "marketplace", "add", "https://github.com/user/m2.git"],
|
||||||
|
{ stdio: "inherit" },
|
||||||
|
);
|
||||||
|
// Third call: install plugin
|
||||||
|
expect(spy).toHaveBeenNthCalledWith(
|
||||||
|
3,
|
||||||
|
"claude",
|
||||||
|
["plugin", "install", "test-plugin"],
|
||||||
|
{ stdio: "inherit" },
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should add marketplaces before installing multiple plugins", async () => {
|
||||||
|
const spy = createMockSpawn();
|
||||||
|
await installPlugins(
|
||||||
|
"https://github.com/user/marketplace.git",
|
||||||
|
"plugin1\nplugin2",
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(spy).toHaveBeenCalledTimes(3); // 1 marketplace + 2 plugins
|
||||||
|
// First call: add marketplace
|
||||||
|
expect(spy).toHaveBeenNthCalledWith(
|
||||||
|
1,
|
||||||
|
"claude",
|
||||||
|
[
|
||||||
|
"plugin",
|
||||||
|
"marketplace",
|
||||||
|
"add",
|
||||||
|
"https://github.com/user/marketplace.git",
|
||||||
|
],
|
||||||
|
{ stdio: "inherit" },
|
||||||
|
);
|
||||||
|
// Next calls: install plugins
|
||||||
|
expect(spy).toHaveBeenNthCalledWith(
|
||||||
|
2,
|
||||||
|
"claude",
|
||||||
|
["plugin", "install", "plugin1"],
|
||||||
|
{ stdio: "inherit" },
|
||||||
|
);
|
||||||
|
expect(spy).toHaveBeenNthCalledWith(
|
||||||
|
3,
|
||||||
|
"claude",
|
||||||
|
["plugin", "install", "plugin2"],
|
||||||
|
{ stdio: "inherit" },
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should handle only marketplaces without plugins", async () => {
|
||||||
|
const spy = createMockSpawn();
|
||||||
|
await installPlugins("https://github.com/user/marketplace.git", undefined);
|
||||||
|
|
||||||
|
expect(spy).toHaveBeenCalledTimes(1);
|
||||||
|
expect(spy).toHaveBeenNthCalledWith(
|
||||||
|
1,
|
||||||
|
"claude",
|
||||||
|
[
|
||||||
|
"plugin",
|
||||||
|
"marketplace",
|
||||||
|
"add",
|
||||||
|
"https://github.com/user/marketplace.git",
|
||||||
|
],
|
||||||
|
{ stdio: "inherit" },
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should skip empty marketplace entries", async () => {
|
||||||
|
const spy = createMockSpawn();
|
||||||
|
await installPlugins(
|
||||||
|
"https://github.com/user/m1.git\n\nhttps://github.com/user/m2.git",
|
||||||
|
"test-plugin",
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(spy).toHaveBeenCalledTimes(3); // 2 marketplaces (skip empty) + 1 plugin
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should trim whitespace from marketplace URLs", async () => {
|
||||||
|
const spy = createMockSpawn();
|
||||||
|
await installPlugins(
|
||||||
|
" https://github.com/user/marketplace.git \n https://github.com/user/m2.git ",
|
||||||
|
"test-plugin",
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(spy).toHaveBeenCalledTimes(3);
|
||||||
|
expect(spy).toHaveBeenNthCalledWith(
|
||||||
|
1,
|
||||||
|
"claude",
|
||||||
|
[
|
||||||
|
"plugin",
|
||||||
|
"marketplace",
|
||||||
|
"add",
|
||||||
|
"https://github.com/user/marketplace.git",
|
||||||
|
],
|
||||||
|
{ stdio: "inherit" },
|
||||||
|
);
|
||||||
|
expect(spy).toHaveBeenNthCalledWith(
|
||||||
|
2,
|
||||||
|
"claude",
|
||||||
|
["plugin", "marketplace", "add", "https://github.com/user/m2.git"],
|
||||||
|
{ stdio: "inherit" },
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should reject invalid marketplace URL format", async () => {
|
||||||
|
const spy = createMockSpawn();
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
installPlugins("not-a-valid-url", "test-plugin"),
|
||||||
|
).rejects.toThrow("Invalid marketplace URL format");
|
||||||
|
|
||||||
|
expect(spy).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should reject marketplace URL without .git extension", async () => {
|
||||||
|
const spy = createMockSpawn();
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
installPlugins("https://github.com/user/marketplace", "test-plugin"),
|
||||||
|
).rejects.toThrow("Invalid marketplace URL format");
|
||||||
|
|
||||||
|
expect(spy).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should reject marketplace URL with non-https protocol", async () => {
|
||||||
|
const spy = createMockSpawn();
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
installPlugins("http://github.com/user/marketplace.git", "test-plugin"),
|
||||||
|
).rejects.toThrow("Invalid marketplace URL format");
|
||||||
|
|
||||||
|
expect(spy).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should skip whitespace-only marketplace input", async () => {
|
||||||
|
const spy = createMockSpawn();
|
||||||
|
await installPlugins(" ", "test-plugin");
|
||||||
|
|
||||||
|
// Should skip marketplaces and only install plugin
|
||||||
|
expect(spy).toHaveBeenCalledTimes(1);
|
||||||
|
expect(spy).toHaveBeenNthCalledWith(
|
||||||
|
1,
|
||||||
|
"claude",
|
||||||
|
["plugin", "install", "test-plugin"],
|
||||||
|
{ stdio: "inherit" },
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should handle marketplace addition error", async () => {
|
||||||
|
createMockSpawn(1, false); // Exit code 1
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
installPlugins("https://github.com/user/marketplace.git", "test-plugin"),
|
||||||
|
).rejects.toThrow(
|
||||||
|
"Failed to add marketplace 'https://github.com/user/marketplace.git' (exit code: 1)",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should stop if marketplace addition fails before installing plugins", async () => {
|
||||||
|
const spy = createMockSpawn(1, false); // Exit code 1
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
installPlugins(
|
||||||
|
"https://github.com/user/marketplace.git",
|
||||||
|
"plugin1\nplugin2",
|
||||||
|
),
|
||||||
|
).rejects.toThrow("Failed to add marketplace");
|
||||||
|
|
||||||
|
// Should only try to add marketplace, not install any plugins
|
||||||
|
expect(spy).toHaveBeenCalledTimes(1);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should use custom executable for marketplace operations", async () => {
|
||||||
|
const spy = createMockSpawn();
|
||||||
|
await installPlugins(
|
||||||
|
"https://github.com/user/marketplace.git",
|
||||||
|
"test-plugin",
|
||||||
|
"/custom/path/to/claude",
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(spy).toHaveBeenCalledTimes(2);
|
||||||
|
expect(spy).toHaveBeenNthCalledWith(
|
||||||
|
1,
|
||||||
|
"/custom/path/to/claude",
|
||||||
|
[
|
||||||
|
"plugin",
|
||||||
|
"marketplace",
|
||||||
|
"add",
|
||||||
|
"https://github.com/user/marketplace.git",
|
||||||
|
],
|
||||||
|
{ stdio: "inherit" },
|
||||||
|
);
|
||||||
|
expect(spy).toHaveBeenNthCalledWith(
|
||||||
|
2,
|
||||||
|
"/custom/path/to/claude",
|
||||||
|
["plugin", "install", "test-plugin"],
|
||||||
|
{ stdio: "inherit" },
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
744
docs/create-app.html
Normal file
744
docs/create-app.html
Normal file
@@ -0,0 +1,744 @@
|
|||||||
|
<!doctype html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<title>Create Claude Code GitHub App</title>
|
||||||
|
<style>
|
||||||
|
* {
|
||||||
|
box-sizing: border-box;
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
:root {
|
||||||
|
/* Claude Brand Colors */
|
||||||
|
--primary-dark: #0e0e0e;
|
||||||
|
--primary-light: #d4a27f;
|
||||||
|
--background-light: rgb(253, 253, 247);
|
||||||
|
--background-dark: rgb(9, 9, 11);
|
||||||
|
--text-primary: #1a1a1a;
|
||||||
|
--text-secondary: #525252;
|
||||||
|
--text-tertiary: #737373;
|
||||||
|
--border-color: rgba(0, 0, 0, 0.08);
|
||||||
|
--hover-bg: rgba(0, 0, 0, 0.02);
|
||||||
|
--success: #2ea44f;
|
||||||
|
--warning: #e3b341;
|
||||||
|
--card-shadow:
|
||||||
|
0 1px 3px rgba(0, 0, 0, 0.06), 0 1px 2px rgba(0, 0, 0, 0.04);
|
||||||
|
--card-shadow-hover:
|
||||||
|
0 4px 6px rgba(0, 0, 0, 0.07), 0 2px 4px rgba(0, 0, 0, 0.05);
|
||||||
|
}
|
||||||
|
|
||||||
|
body {
|
||||||
|
font-family:
|
||||||
|
-apple-system, BlinkMacSystemFont, "Segoe UI", Roboto,
|
||||||
|
"Helvetica Neue", Arial, sans-serif;
|
||||||
|
background: var(--background-light);
|
||||||
|
color: var(--text-primary);
|
||||||
|
line-height: 1.6;
|
||||||
|
-webkit-font-smoothing: antialiased;
|
||||||
|
-moz-osx-font-smoothing: grayscale;
|
||||||
|
}
|
||||||
|
|
||||||
|
.container {
|
||||||
|
max-width: 960px;
|
||||||
|
margin: 0 auto;
|
||||||
|
padding: 40px 24px;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Header */
|
||||||
|
header {
|
||||||
|
text-align: center;
|
||||||
|
margin-bottom: 48px;
|
||||||
|
}
|
||||||
|
|
||||||
|
h1 {
|
||||||
|
font-size: 36px;
|
||||||
|
font-weight: 600;
|
||||||
|
color: var(--text-primary);
|
||||||
|
margin-bottom: 12px;
|
||||||
|
letter-spacing: -0.02em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.subtitle {
|
||||||
|
font-size: 18px;
|
||||||
|
color: var(--text-secondary);
|
||||||
|
max-width: 640px;
|
||||||
|
margin: 0 auto;
|
||||||
|
line-height: 1.5;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Cards */
|
||||||
|
.card {
|
||||||
|
background: white;
|
||||||
|
border: 1px solid var(--border-color);
|
||||||
|
border-radius: 12px;
|
||||||
|
padding: 32px;
|
||||||
|
margin-bottom: 24px;
|
||||||
|
box-shadow: var(--card-shadow);
|
||||||
|
transition: all 0.2s ease;
|
||||||
|
}
|
||||||
|
|
||||||
|
.card:hover {
|
||||||
|
box-shadow: var(--card-shadow-hover);
|
||||||
|
}
|
||||||
|
|
||||||
|
.card-header {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 12px;
|
||||||
|
margin-bottom: 20px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.card-icon {
|
||||||
|
font-size: 24px;
|
||||||
|
line-height: 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
h2 {
|
||||||
|
font-size: 20px;
|
||||||
|
font-weight: 600;
|
||||||
|
color: var(--text-primary);
|
||||||
|
margin: 0;
|
||||||
|
letter-spacing: -0.01em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.card-description {
|
||||||
|
color: var(--text-secondary);
|
||||||
|
margin-bottom: 24px;
|
||||||
|
font-size: 15px;
|
||||||
|
line-height: 1.6;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Buttons */
|
||||||
|
.button-group {
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
gap: 16px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.btn {
|
||||||
|
display: inline-flex;
|
||||||
|
align-items: center;
|
||||||
|
justify-content: center;
|
||||||
|
gap: 8px;
|
||||||
|
padding: 12px 24px;
|
||||||
|
font-size: 15px;
|
||||||
|
font-weight: 500;
|
||||||
|
border-radius: 8px;
|
||||||
|
border: none;
|
||||||
|
cursor: pointer;
|
||||||
|
transition: all 0.2s ease;
|
||||||
|
text-decoration: none;
|
||||||
|
font-family: inherit;
|
||||||
|
width: 100%;
|
||||||
|
}
|
||||||
|
|
||||||
|
.btn-primary {
|
||||||
|
background: var(--primary-dark);
|
||||||
|
color: white;
|
||||||
|
}
|
||||||
|
|
||||||
|
.btn-primary:hover {
|
||||||
|
background: #1a1a1a;
|
||||||
|
transform: translateY(-1px);
|
||||||
|
box-shadow: 0 4px 12px rgba(0, 0, 0, 0.15);
|
||||||
|
}
|
||||||
|
|
||||||
|
.btn-secondary {
|
||||||
|
background: var(--primary-light);
|
||||||
|
color: var(--primary-dark);
|
||||||
|
}
|
||||||
|
|
||||||
|
.btn-secondary:hover {
|
||||||
|
background: #c99a70;
|
||||||
|
transform: translateY(-1px);
|
||||||
|
box-shadow: 0 4px 12px rgba(212, 162, 127, 0.3);
|
||||||
|
}
|
||||||
|
|
||||||
|
.btn-outline {
|
||||||
|
background: white;
|
||||||
|
color: var(--text-primary);
|
||||||
|
border: 1px solid var(--border-color);
|
||||||
|
}
|
||||||
|
|
||||||
|
.btn-outline:hover {
|
||||||
|
background: var(--hover-bg);
|
||||||
|
border-color: var(--text-secondary);
|
||||||
|
}
|
||||||
|
|
||||||
|
.btn:active {
|
||||||
|
transform: translateY(0);
|
||||||
|
}
|
||||||
|
|
||||||
|
.btn.copied {
|
||||||
|
background: var(--success);
|
||||||
|
color: white;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Form */
|
||||||
|
.form-row {
|
||||||
|
display: flex;
|
||||||
|
gap: 12px;
|
||||||
|
align-items: flex-end;
|
||||||
|
}
|
||||||
|
|
||||||
|
.form-group {
|
||||||
|
flex: 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
label {
|
||||||
|
display: block;
|
||||||
|
font-size: 14px;
|
||||||
|
font-weight: 500;
|
||||||
|
color: var(--text-primary);
|
||||||
|
margin-bottom: 6px;
|
||||||
|
}
|
||||||
|
|
||||||
|
input[type="text"] {
|
||||||
|
width: 100%;
|
||||||
|
padding: 10px 14px;
|
||||||
|
font-size: 15px;
|
||||||
|
border: 1px solid var(--border-color);
|
||||||
|
border-radius: 8px;
|
||||||
|
font-family: inherit;
|
||||||
|
transition: all 0.2s ease;
|
||||||
|
background: white;
|
||||||
|
}
|
||||||
|
|
||||||
|
input[type="text"]:focus {
|
||||||
|
outline: none;
|
||||||
|
border-color: var(--primary-dark);
|
||||||
|
box-shadow: 0 0 0 3px rgba(14, 14, 14, 0.1);
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Code Block */
|
||||||
|
.code-container {
|
||||||
|
position: relative;
|
||||||
|
background: #fafafa;
|
||||||
|
border: 1px solid var(--border-color);
|
||||||
|
border-radius: 8px;
|
||||||
|
margin: 20px 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.code-header {
|
||||||
|
display: flex;
|
||||||
|
justify-content: space-between;
|
||||||
|
align-items: center;
|
||||||
|
padding: 12px 16px;
|
||||||
|
border-bottom: 1px solid var(--border-color);
|
||||||
|
}
|
||||||
|
|
||||||
|
.code-label {
|
||||||
|
font-size: 13px;
|
||||||
|
font-weight: 500;
|
||||||
|
color: var(--text-secondary);
|
||||||
|
}
|
||||||
|
|
||||||
|
.copy-btn {
|
||||||
|
padding: 6px 12px;
|
||||||
|
font-size: 13px;
|
||||||
|
font-weight: 500;
|
||||||
|
background: white;
|
||||||
|
color: var(--text-primary);
|
||||||
|
border: 1px solid var(--border-color);
|
||||||
|
border-radius: 6px;
|
||||||
|
cursor: pointer;
|
||||||
|
transition: all 0.2s ease;
|
||||||
|
}
|
||||||
|
|
||||||
|
.copy-btn:hover {
|
||||||
|
background: var(--hover-bg);
|
||||||
|
}
|
||||||
|
|
||||||
|
.copy-btn.copied {
|
||||||
|
background: var(--success);
|
||||||
|
color: white;
|
||||||
|
border-color: var(--success);
|
||||||
|
}
|
||||||
|
|
||||||
|
.code-block {
|
||||||
|
padding: 16px;
|
||||||
|
overflow-x: auto;
|
||||||
|
font-family:
|
||||||
|
"SF Mono", Monaco, "Cascadia Code", "Roboto Mono", Consolas,
|
||||||
|
"Courier New", monospace;
|
||||||
|
font-size: 13px;
|
||||||
|
line-height: 1.6;
|
||||||
|
color: var(--text-primary);
|
||||||
|
white-space: pre;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Permissions List */
|
||||||
|
.permissions-grid {
|
||||||
|
display: grid;
|
||||||
|
gap: 12px;
|
||||||
|
margin-top: 16px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.permission-item {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 10px;
|
||||||
|
padding: 10px 14px;
|
||||||
|
background: #fafafa;
|
||||||
|
border-radius: 8px;
|
||||||
|
font-size: 14px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.permission-icon {
|
||||||
|
color: var(--success);
|
||||||
|
font-size: 16px;
|
||||||
|
line-height: 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
.permission-name {
|
||||||
|
font-weight: 500;
|
||||||
|
color: var(--text-primary);
|
||||||
|
}
|
||||||
|
|
||||||
|
.permission-value {
|
||||||
|
margin-left: auto;
|
||||||
|
color: var(--text-secondary);
|
||||||
|
font-size: 13px;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Steps */
|
||||||
|
.steps {
|
||||||
|
margin: 24px 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.step {
|
||||||
|
display: flex;
|
||||||
|
gap: 16px;
|
||||||
|
margin-bottom: 20px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.step-number {
|
||||||
|
flex-shrink: 0;
|
||||||
|
width: 28px;
|
||||||
|
height: 28px;
|
||||||
|
background: var(--primary-dark);
|
||||||
|
color: white;
|
||||||
|
border-radius: 50%;
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
justify-content: center;
|
||||||
|
font-size: 14px;
|
||||||
|
font-weight: 600;
|
||||||
|
}
|
||||||
|
|
||||||
|
.step-content {
|
||||||
|
flex: 1;
|
||||||
|
padding-top: 2px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.step-content p {
|
||||||
|
color: var(--text-secondary);
|
||||||
|
font-size: 15px;
|
||||||
|
line-height: 1.6;
|
||||||
|
}
|
||||||
|
|
||||||
|
.step-content strong {
|
||||||
|
color: var(--text-primary);
|
||||||
|
font-weight: 500;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Alert Box */
|
||||||
|
.alert {
|
||||||
|
display: flex;
|
||||||
|
gap: 12px;
|
||||||
|
padding: 16px;
|
||||||
|
background: #fffbf0;
|
||||||
|
border: 1px solid #f5e7c3;
|
||||||
|
border-radius: 8px;
|
||||||
|
margin-top: 32px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.alert-icon {
|
||||||
|
font-size: 18px;
|
||||||
|
line-height: 1;
|
||||||
|
flex-shrink: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.alert-content {
|
||||||
|
flex: 1;
|
||||||
|
font-size: 14px;
|
||||||
|
line-height: 1.6;
|
||||||
|
}
|
||||||
|
|
||||||
|
.alert-content strong {
|
||||||
|
color: var(--text-primary);
|
||||||
|
font-weight: 600;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Responsive */
|
||||||
|
@media (min-width: 640px) {
|
||||||
|
.button-group {
|
||||||
|
flex-direction: row;
|
||||||
|
}
|
||||||
|
|
||||||
|
.btn {
|
||||||
|
width: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
.permissions-grid {
|
||||||
|
grid-template-columns: repeat(2, 1fr);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@media (max-width: 640px) {
|
||||||
|
h1 {
|
||||||
|
font-size: 28px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.subtitle {
|
||||||
|
font-size: 16px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.card {
|
||||||
|
padding: 24px 20px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.container {
|
||||||
|
padding: 24px 16px;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Hidden form elements */
|
||||||
|
.hidden-form {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div class="container">
|
||||||
|
<header>
|
||||||
|
<h1>Create Your Custom GitHub App</h1>
|
||||||
|
<p class="subtitle">
|
||||||
|
Set up a custom GitHub App for Claude Code Action with all required
|
||||||
|
permissions automatically configured.
|
||||||
|
</p>
|
||||||
|
</header>
|
||||||
|
|
||||||
|
<!-- Quick Setup Card -->
|
||||||
|
<div class="card">
|
||||||
|
<div class="card-header">
|
||||||
|
<span class="card-icon">🚀</span>
|
||||||
|
<h2>Quick Setup</h2>
|
||||||
|
</div>
|
||||||
|
<p class="card-description">
|
||||||
|
Create your GitHub App with one click. All permissions will be
|
||||||
|
automatically configured for Claude Code Action.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<div class="button-group">
|
||||||
|
<!-- Personal Account Button -->
|
||||||
|
<form
|
||||||
|
action="https://github.com/settings/apps/new"
|
||||||
|
method="post"
|
||||||
|
class="hidden-form"
|
||||||
|
id="personal-form"
|
||||||
|
>
|
||||||
|
<input type="hidden" name="manifest" id="personal-manifest" />
|
||||||
|
</form>
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
class="btn btn-primary"
|
||||||
|
onclick="submitPersonalForm()"
|
||||||
|
>
|
||||||
|
<span>👤</span>
|
||||||
|
<span>Create for Personal Account</span>
|
||||||
|
</button>
|
||||||
|
|
||||||
|
<!-- Organization Form -->
|
||||||
|
<form id="org-form" method="post" class="hidden-form">
|
||||||
|
<input type="hidden" name="manifest" id="org-manifest" />
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- Organization Input -->
|
||||||
|
<div
|
||||||
|
style="
|
||||||
|
margin-top: 24px;
|
||||||
|
padding-top: 24px;
|
||||||
|
border-top: 1px solid var(--border-color);
|
||||||
|
"
|
||||||
|
>
|
||||||
|
<label for="org-name" style="margin-bottom: 8px"
|
||||||
|
>Or create for an organization:</label
|
||||||
|
>
|
||||||
|
<div class="form-row">
|
||||||
|
<div class="form-group">
|
||||||
|
<input
|
||||||
|
type="text"
|
||||||
|
id="org-name"
|
||||||
|
placeholder="Enter organization name (e.g., my-org)"
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
class="btn btn-secondary"
|
||||||
|
onclick="submitOrgForm()"
|
||||||
|
style="flex-shrink: 0"
|
||||||
|
>
|
||||||
|
<span>🏢</span>
|
||||||
|
<span>Create for Org</span>
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- Permissions Card -->
|
||||||
|
<div class="card">
|
||||||
|
<div class="card-header">
|
||||||
|
<span class="card-icon">✅</span>
|
||||||
|
<h2>Configured Permissions</h2>
|
||||||
|
</div>
|
||||||
|
<p class="card-description">
|
||||||
|
Your GitHub App will be created with these permissions:
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<div class="permissions-grid">
|
||||||
|
<div class="permission-item">
|
||||||
|
<span class="permission-icon">✓</span>
|
||||||
|
<span class="permission-name">Contents</span>
|
||||||
|
<span class="permission-value">Read & Write</span>
|
||||||
|
</div>
|
||||||
|
<div class="permission-item">
|
||||||
|
<span class="permission-icon">✓</span>
|
||||||
|
<span class="permission-name">Issues</span>
|
||||||
|
<span class="permission-value">Read & Write</span>
|
||||||
|
</div>
|
||||||
|
<div class="permission-item">
|
||||||
|
<span class="permission-icon">✓</span>
|
||||||
|
<span class="permission-name">Pull Requests</span>
|
||||||
|
<span class="permission-value">Read & Write</span>
|
||||||
|
</div>
|
||||||
|
<div class="permission-item">
|
||||||
|
<span class="permission-icon">✓</span>
|
||||||
|
<span class="permission-name">Actions</span>
|
||||||
|
<span class="permission-value">Read</span>
|
||||||
|
</div>
|
||||||
|
<div class="permission-item">
|
||||||
|
<span class="permission-icon">✓</span>
|
||||||
|
<span class="permission-name">Metadata</span>
|
||||||
|
<span class="permission-value">Read</span>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- Next Steps Card -->
|
||||||
|
<div class="card">
|
||||||
|
<div class="card-header">
|
||||||
|
<span class="card-icon">📋</span>
|
||||||
|
<h2>Next Steps</h2>
|
||||||
|
</div>
|
||||||
|
<p class="card-description">
|
||||||
|
After creating your app, complete these steps:
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<div class="steps">
|
||||||
|
<div class="step">
|
||||||
|
<div class="step-number">1</div>
|
||||||
|
<div class="step-content">
|
||||||
|
<p>
|
||||||
|
<strong>Generate a private key:</strong> In your app settings,
|
||||||
|
scroll to "Private keys" and click "Generate a private key"
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="step">
|
||||||
|
<div class="step-number">2</div>
|
||||||
|
<div class="step-content">
|
||||||
|
<p>
|
||||||
|
<strong>Install the app:</strong> Click "Install App" and select
|
||||||
|
the repositories where you want to use Claude
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="step">
|
||||||
|
<div class="step-number">3</div>
|
||||||
|
<div class="step-content">
|
||||||
|
<p>
|
||||||
|
<strong>Configure your workflow:</strong> Add your app's ID and
|
||||||
|
private key to your repository secrets
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- Manual Setup Card -->
|
||||||
|
<div class="card">
|
||||||
|
<div class="card-header">
|
||||||
|
<span class="card-icon">⚙️</span>
|
||||||
|
<h2>Manual Setup</h2>
|
||||||
|
</div>
|
||||||
|
<p class="card-description">
|
||||||
|
If the buttons above don't work, you can manually create the app by
|
||||||
|
copying the manifest JSON below:
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<div class="code-container">
|
||||||
|
<div class="code-header">
|
||||||
|
<span class="code-label">github-app-manifest.json</span>
|
||||||
|
<button class="copy-btn" onclick="copyManifest()">Copy</button>
|
||||||
|
</div>
|
||||||
|
<div class="code-block" id="manifest-json"></div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="steps">
|
||||||
|
<div class="step">
|
||||||
|
<div class="step-number">1</div>
|
||||||
|
<div class="step-content">
|
||||||
|
<p>Copy the manifest JSON above</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="step">
|
||||||
|
<div class="step-number">2</div>
|
||||||
|
<div class="step-content">
|
||||||
|
<p>
|
||||||
|
Go to
|
||||||
|
<a
|
||||||
|
href="https://github.com/settings/apps/new"
|
||||||
|
target="_blank"
|
||||||
|
style="color: var(--primary-dark); text-decoration: underline"
|
||||||
|
>GitHub App Settings</a
|
||||||
|
>
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="step">
|
||||||
|
<div class="step-number">3</div>
|
||||||
|
<div class="step-content">
|
||||||
|
<p>Look for "Create from manifest" option and paste the JSON</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- Warning Alert -->
|
||||||
|
<div class="alert">
|
||||||
|
<span class="alert-icon">⚠️</span>
|
||||||
|
<div class="alert-content">
|
||||||
|
<strong>Important:</strong> Keep your private key secure! Never commit
|
||||||
|
it to your repository. Always use GitHub secrets to store sensitive
|
||||||
|
credentials.
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<script>
|
||||||
|
// Manifest configuration
|
||||||
|
const manifest = {
|
||||||
|
name: "Claude Code Custom App",
|
||||||
|
description:
|
||||||
|
"Custom GitHub App for Claude Code Action - AI-powered coding assistant for GitHub workflows",
|
||||||
|
url: "https://github.com/anthropics/claude-code-action",
|
||||||
|
hook_attributes: {
|
||||||
|
url: "https://example.com/github/webhook",
|
||||||
|
active: false,
|
||||||
|
},
|
||||||
|
redirect_url: "https://github.com/settings/apps/new",
|
||||||
|
callback_urls: [],
|
||||||
|
setup_url:
|
||||||
|
"https://github.com/anthropics/claude-code-action/blob/main/docs/setup.md",
|
||||||
|
public: false,
|
||||||
|
default_permissions: {
|
||||||
|
contents: "write",
|
||||||
|
issues: "write",
|
||||||
|
pull_requests: "write",
|
||||||
|
actions: "read",
|
||||||
|
metadata: "read",
|
||||||
|
},
|
||||||
|
default_events: [
|
||||||
|
"issue_comment",
|
||||||
|
"issues",
|
||||||
|
"pull_request",
|
||||||
|
"pull_request_review",
|
||||||
|
"pull_request_review_comment",
|
||||||
|
],
|
||||||
|
};
|
||||||
|
|
||||||
|
// Populate manifest fields
|
||||||
|
const manifestJson = JSON.stringify(manifest);
|
||||||
|
const manifestJsonPretty = JSON.stringify(manifest, null, 2);
|
||||||
|
|
||||||
|
document.getElementById("personal-manifest").value = manifestJson;
|
||||||
|
document.getElementById("org-manifest").value = manifestJson;
|
||||||
|
|
||||||
|
// Display formatted JSON
|
||||||
|
const manifestDisplay = document.getElementById("manifest-json");
|
||||||
|
manifestDisplay.textContent = manifestJsonPretty;
|
||||||
|
|
||||||
|
// Submit personal form
|
||||||
|
function submitPersonalForm() {
|
||||||
|
document.getElementById("personal-form").submit();
|
||||||
|
}
|
||||||
|
|
||||||
|
// Submit organization form
|
||||||
|
function submitOrgForm() {
|
||||||
|
const orgName = document.getElementById("org-name").value.trim();
|
||||||
|
if (!orgName) {
|
||||||
|
alert("Please enter an organization name");
|
||||||
|
document.getElementById("org-name").focus();
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const form = document.getElementById("org-form");
|
||||||
|
form.action = `https://github.com/organizations/${orgName}/settings/apps/new`;
|
||||||
|
form.submit();
|
||||||
|
}
|
||||||
|
|
||||||
|
// Allow Enter key to submit org form
|
||||||
|
document
|
||||||
|
.getElementById("org-name")
|
||||||
|
.addEventListener("keypress", function (e) {
|
||||||
|
if (e.key === "Enter") {
|
||||||
|
e.preventDefault();
|
||||||
|
submitOrgForm();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// Copy manifest to clipboard
|
||||||
|
function copyManifest() {
|
||||||
|
navigator.clipboard
|
||||||
|
.writeText(manifestJsonPretty)
|
||||||
|
.then(() => {
|
||||||
|
const button = document.querySelector(".copy-btn");
|
||||||
|
const originalText = button.textContent;
|
||||||
|
button.textContent = "Copied!";
|
||||||
|
button.classList.add("copied");
|
||||||
|
setTimeout(() => {
|
||||||
|
button.textContent = originalText;
|
||||||
|
button.classList.remove("copied");
|
||||||
|
}, 2000);
|
||||||
|
})
|
||||||
|
.catch(() => {
|
||||||
|
// Fallback for older browsers
|
||||||
|
const textArea = document.createElement("textarea");
|
||||||
|
textArea.value = manifestJsonPretty;
|
||||||
|
textArea.style.position = "fixed";
|
||||||
|
textArea.style.opacity = "0";
|
||||||
|
document.body.appendChild(textArea);
|
||||||
|
textArea.select();
|
||||||
|
try {
|
||||||
|
document.execCommand("copy");
|
||||||
|
const button = document.querySelector(".copy-btn");
|
||||||
|
const originalText = button.textContent;
|
||||||
|
button.textContent = "Copied!";
|
||||||
|
button.classList.add("copied");
|
||||||
|
setTimeout(() => {
|
||||||
|
button.textContent = originalText;
|
||||||
|
button.classList.remove("copied");
|
||||||
|
}, 2000);
|
||||||
|
} catch (err) {
|
||||||
|
alert("Failed to copy. Please copy manually.");
|
||||||
|
}
|
||||||
|
document.body.removeChild(textArea);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@@ -15,7 +15,7 @@ The action automatically detects which mode to use based on your configuration:
|
|||||||
|
|
||||||
This action supports the following GitHub events ([learn more GitHub event triggers](https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows)):
|
This action supports the following GitHub events ([learn more GitHub event triggers](https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows)):
|
||||||
|
|
||||||
- `pull_request` - When PRs are opened or synchronized
|
- `pull_request` or `pull_request_target` - When PRs are opened or synchronized
|
||||||
- `issue_comment` - When comments are created on issues or PRs
|
- `issue_comment` - When comments are created on issues or PRs
|
||||||
- `pull_request_comment` - When comments are made on PR diffs
|
- `pull_request_comment` - When comments are made on PR diffs
|
||||||
- `issues` - When issues are opened or assigned
|
- `issues` - When issues are opened or assigned
|
||||||
|
|||||||
@@ -127,7 +127,7 @@ For performance, Claude uses shallow clones:
|
|||||||
If you need full history, you can configure this in your workflow before calling Claude in the `actions/checkout` step.
|
If you need full history, you can configure this in your workflow before calling Claude in the `actions/checkout` step.
|
||||||
|
|
||||||
```
|
```
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v5
|
||||||
depth: 0 # will fetch full repo history
|
depth: 0 # will fetch full repo history
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -13,13 +13,28 @@
|
|||||||
- **No Cross-Repository Access**: Each action invocation is limited to the repository where it was triggered
|
- **No Cross-Repository Access**: Each action invocation is limited to the repository where it was triggered
|
||||||
- **Limited Scope**: The token cannot access other repositories or perform actions beyond the configured permissions
|
- **Limited Scope**: The token cannot access other repositories or perform actions beyond the configured permissions
|
||||||
|
|
||||||
|
## ⚠️ Prompt Injection Risks
|
||||||
|
|
||||||
|
**Beware of potential hidden markdown when tagging Claude on untrusted content.** External contributors may include hidden instructions through HTML comments, invisible characters, hidden attributes, or other techniques. The action sanitizes content by stripping HTML comments, invisible characters, markdown image alt text, hidden HTML attributes, and HTML entities, but new bypass techniques may emerge. We recommend reviewing the raw content of all input coming from external contributors before allowing Claude to process it.
|
||||||
|
|
||||||
## GitHub App Permissions
|
## GitHub App Permissions
|
||||||
|
|
||||||
The [Claude Code GitHub app](https://github.com/apps/claude) requires these permissions:
|
The [Claude Code GitHub app](https://github.com/apps/claude) requests the following permissions:
|
||||||
|
|
||||||
- **Pull Requests**: Read and write to create PRs and push changes
|
### Currently Used Permissions
|
||||||
- **Issues**: Read and write to respond to issues
|
|
||||||
- **Contents**: Read and write to modify repository files
|
- **Contents** (Read & Write): For reading repository files and creating branches
|
||||||
|
- **Pull Requests** (Read & Write): For reading PR data and creating/updating pull requests
|
||||||
|
- **Issues** (Read & Write): For reading issue data and updating issue comments
|
||||||
|
|
||||||
|
### Permissions for Future Features
|
||||||
|
|
||||||
|
The following permissions are requested but not yet actively used. These will enable planned features in future releases:
|
||||||
|
|
||||||
|
- **Discussions** (Read & Write): For interaction with GitHub Discussions
|
||||||
|
- **Actions** (Read): For accessing workflow run data and logs
|
||||||
|
- **Checks** (Read): For reading check run results
|
||||||
|
- **Workflows** (Read & Write): For triggering and managing GitHub Actions workflows
|
||||||
|
|
||||||
## Commit Signing
|
## Commit Signing
|
||||||
|
|
||||||
|
|||||||
@@ -20,7 +20,48 @@ If you prefer not to install the official Claude app, you can create your own Gi
|
|||||||
- Organization policies prevent installing third-party apps
|
- Organization policies prevent installing third-party apps
|
||||||
- You're using AWS Bedrock or Google Vertex AI
|
- You're using AWS Bedrock or Google Vertex AI
|
||||||
|
|
||||||
**Steps to create and use a custom GitHub App:**
|
### Option 1: Quick Setup with App Manifest (Recommended)
|
||||||
|
|
||||||
|
The fastest way to create a custom GitHub App is using our pre-configured manifest. This ensures all permissions are correctly set up with a single click.
|
||||||
|
|
||||||
|
**Steps:**
|
||||||
|
|
||||||
|
1. **Create the app:**
|
||||||
|
|
||||||
|
**🚀 [Download the Quick Setup Tool](./create-app.html)** (Right-click → "Save Link As" or "Download Linked File")
|
||||||
|
|
||||||
|
After downloading, open `create-app.html` in your web browser:
|
||||||
|
|
||||||
|
- **For Personal Accounts:** Click the "Create App for Personal Account" button
|
||||||
|
- **For Organizations:** Enter your organization name and click "Create App for Organization"
|
||||||
|
|
||||||
|
The tool will automatically configure all required permissions and submit the manifest.
|
||||||
|
|
||||||
|
Alternatively, you can use the manifest file directly:
|
||||||
|
|
||||||
|
- Use the [`github-app-manifest.json`](../github-app-manifest.json) file from this repository
|
||||||
|
- Visit https://github.com/settings/apps/new (for personal) or your organization's app settings
|
||||||
|
- Look for the "Create from manifest" option and paste the JSON content
|
||||||
|
|
||||||
|
2. **Complete the creation flow:**
|
||||||
|
|
||||||
|
- GitHub will show you a preview of the app configuration
|
||||||
|
- Confirm the app name (you can customize it)
|
||||||
|
- Click "Create GitHub App"
|
||||||
|
- The app will be created with all required permissions automatically configured
|
||||||
|
|
||||||
|
3. **Generate and download a private key:**
|
||||||
|
|
||||||
|
- After creating the app, you'll be redirected to the app settings
|
||||||
|
- Scroll down to "Private keys"
|
||||||
|
- Click "Generate a private key"
|
||||||
|
- Download the `.pem` file (keep this secure!)
|
||||||
|
|
||||||
|
4. **Continue with installation** - Skip to step 3 in the manual setup below to install the app and configure your workflow.
|
||||||
|
|
||||||
|
### Option 2: Manual Setup
|
||||||
|
|
||||||
|
If you prefer to configure the app manually or need custom permissions:
|
||||||
|
|
||||||
1. **Create a new GitHub App:**
|
1. **Create a new GitHub App:**
|
||||||
|
|
||||||
|
|||||||
@@ -35,7 +35,7 @@ jobs:
|
|||||||
pull-requests: write
|
pull-requests: write
|
||||||
id-token: write
|
id-token: write
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v5
|
||||||
with:
|
with:
|
||||||
fetch-depth: 1
|
fetch-depth: 1
|
||||||
|
|
||||||
@@ -89,7 +89,7 @@ jobs:
|
|||||||
pull-requests: write
|
pull-requests: write
|
||||||
id-token: write
|
id-token: write
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v5
|
||||||
with:
|
with:
|
||||||
fetch-depth: 1
|
fetch-depth: 1
|
||||||
|
|
||||||
@@ -153,7 +153,7 @@ jobs:
|
|||||||
pull-requests: write
|
pull-requests: write
|
||||||
id-token: write
|
id-token: write
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v5
|
||||||
with:
|
with:
|
||||||
fetch-depth: 1
|
fetch-depth: 1
|
||||||
|
|
||||||
@@ -211,7 +211,7 @@ jobs:
|
|||||||
pull-requests: write
|
pull-requests: write
|
||||||
id-token: write
|
id-token: write
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v5
|
||||||
with:
|
with:
|
||||||
fetch-depth: 1
|
fetch-depth: 1
|
||||||
|
|
||||||
@@ -268,7 +268,7 @@ jobs:
|
|||||||
pull-requests: write
|
pull-requests: write
|
||||||
id-token: write
|
id-token: write
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v5
|
||||||
with:
|
with:
|
||||||
fetch-depth: 1
|
fetch-depth: 1
|
||||||
|
|
||||||
@@ -344,7 +344,7 @@ jobs:
|
|||||||
pull-requests: write
|
pull-requests: write
|
||||||
id-token: write
|
id-token: write
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v5
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
|
|
||||||
@@ -456,7 +456,7 @@ jobs:
|
|||||||
pull-requests: write
|
pull-requests: write
|
||||||
id-token: write
|
id-token: write
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v5
|
||||||
with:
|
with:
|
||||||
ref: ${{ github.event.pull_request.head.ref }}
|
ref: ${{ github.event.pull_request.head.ref }}
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
@@ -513,7 +513,7 @@ jobs:
|
|||||||
security-events: write
|
security-events: write
|
||||||
id-token: write
|
id-token: write
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v5
|
||||||
with:
|
with:
|
||||||
fetch-depth: 1
|
fetch-depth: 1
|
||||||
|
|
||||||
|
|||||||
@@ -32,6 +32,11 @@ jobs:
|
|||||||
# --max-turns 10
|
# --max-turns 10
|
||||||
# --model claude-4-0-sonnet-20250805
|
# --model claude-4-0-sonnet-20250805
|
||||||
|
|
||||||
|
# Optional: add custom plugin marketplaces
|
||||||
|
# plugin_marketplaces: "https://github.com/user/marketplace1.git\nhttps://github.com/user/marketplace2.git"
|
||||||
|
# Optional: install Claude Code plugins
|
||||||
|
# plugins: "code-review@claude-code-plugins\nfeature-dev@claude-code-plugins"
|
||||||
|
|
||||||
# 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
|
||||||
@@ -47,33 +52,34 @@ jobs:
|
|||||||
|
|
||||||
## Inputs
|
## Inputs
|
||||||
|
|
||||||
| Input | Description | Required | Default |
|
| Input | Description | Required | Default |
|
||||||
| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------- | ------------- |
|
| -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------------- |
|
||||||
| `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 | - |
|
| `prompt` | Instructions for Claude. Can be a direct prompt or custom template for automation workflows | No | - |
|
||||||
| `track_progress` | Force tag mode with tracking comments. Only works with specific PR/issue events. Preserves GitHub context | No | `false` |
|
| `track_progress` | Force tag mode with tracking comments. Only works with specific PR/issue events. Preserves GitHub context | No | `false` |
|
||||||
| `claude_args` | Additional arguments to pass directly to Claude CLI (e.g., `--max-turns 10 --model claude-4-0-sonnet-20250805`) | No | "" |
|
| `claude_args` | Additional [arguments to pass directly to Claude CLI](https://docs.claude.com/en/docs/claude-code/cli-reference#cli-flags) (e.g., `--max-turns 10 --model claude-4-0-sonnet-20250805`) | 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` |
|
| `use_sticky_comment` | Use just one comment to deliver PR comments (only applies for pull_request event workflows) | No | `false` |
|
||||||
| `github_token` | GitHub token for Claude to operate with. **Only include this if you're connecting a custom GitHub app of your own!** | No | - |
|
| `github_token` | GitHub token for Claude to operate with. **Only include this if you're connecting a custom GitHub app of your own!** | 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` |
|
||||||
| `use_vertex` | Use Google Vertex AI with OIDC authentication instead of direct Anthropic API | No | `false` |
|
| `use_vertex` | Use Google Vertex AI with OIDC authentication instead of direct Anthropic API | No | `false` |
|
||||||
| `mcp_config` | Additional MCP configuration (JSON string) that merges with the built-in GitHub MCP servers | No | "" |
|
| `assignee_trigger` | The assignee username that triggers the action (e.g. @claude). Only used for issue assignment | No | - |
|
||||||
| `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 | - |
|
||||||
| `label_trigger` | The label name that triggers the action when applied to an issue (e.g. "claude") | No | - |
|
| `trigger_phrase` | The trigger phrase to look for in comments, issue/PR bodies, and issue titles | No | `@claude` |
|
||||||
| `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/` |
|
||||||
| `branch_prefix` | The prefix to use for Claude branches (defaults to 'claude/', use 'claude-' for dash format) | No | `claude/` |
|
| `settings` | Claude Code settings as JSON string or path to settings JSON file | No | "" |
|
||||||
| `settings` | Claude Code settings as JSON string or path to settings JSON file | No | "" |
|
| `additional_permissions` | Additional permissions to enable. Currently supports 'actions: read' for viewing workflow results | No | "" |
|
||||||
| `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 | "" |
|
||||||
| `experimental_allowed_domains` | Restrict network access to these domains only (newline-separated). | No | "" |
|
| `use_commit_signing` | Enable commit signing using GitHub's commit signature verification. When false, Claude uses standard git commands | No | `false` |
|
||||||
| `use_commit_signing` | Enable commit signing using GitHub's commit signature verification. When false, Claude uses standard git commands | No | `false` |
|
| `bot_id` | GitHub user ID to use for git operations (defaults to Claude's bot ID) | No | `41898282` |
|
||||||
| `bot_id` | GitHub user ID to use for git operations (defaults to Claude's bot ID) | No | `41898282` |
|
| `bot_name` | GitHub username to use for git operations (defaults to Claude's bot name) | No | `claude[bot]` |
|
||||||
| `bot_name` | GitHub username to use for git operations (defaults to Claude's bot name) | No | `claude[bot]` |
|
| `allowed_bots` | Comma-separated list of allowed bot usernames, or '\*' to allow all bots. Empty string (default) allows no bots | No | "" |
|
||||||
| `allowed_bots` | Comma-separated list of allowed bot usernames, or '\*' to allow all bots. Empty string (default) allows no bots | No | "" |
|
| `allowed_non_write_users` | **⚠️ RISKY**: Comma-separated list of usernames to allow without write permissions, or '\*' for all users. Only works with `github_token` input. See [Security](./security.md) | No | "" |
|
||||||
| `allowed_non_write_users` | **⚠️ RISKY**: Comma-separated list of usernames to allow without write permissions, or '\*' for all users. Only works with `github_token` input. See [Security](./security.md) | No | "" |
|
| `path_to_claude_code_executable` | Optional path to a custom Claude Code executable. Skips automatic installation. Useful for Nix, custom containers, or specialized environments | No | "" |
|
||||||
| `path_to_claude_code_executable` | Optional path to a custom Claude Code executable. Skips automatic installation. Useful for Nix, custom containers, or specialized environments | No | "" |
|
| `path_to_bun_executable` | Optional path to a custom Bun executable. Skips automatic Bun installation. Useful for Nix, custom containers, or specialized environments | No | "" |
|
||||||
| `path_to_bun_executable` | Optional path to a custom Bun executable. Skips automatic Bun installation. Useful for Nix, custom containers, or specialized environments | No | "" |
|
| `plugin_marketplaces` | Newline-separated list of Claude Code plugin marketplace Git URLs to install from (e.g., see example in workflow above). Marketplaces are added before plugin installation | No | "" |
|
||||||
|
| `plugins` | Newline-separated list of Claude Code plugin names to install (e.g., see example in workflow above). Plugins are installed before Claude Code execution | No | "" |
|
||||||
|
|
||||||
### Deprecated Inputs
|
### Deprecated Inputs
|
||||||
|
|
||||||
@@ -90,6 +96,7 @@ These inputs are deprecated and will be removed in a future version:
|
|||||||
| `fallback_model` | **DEPRECATED**: Use `claude_args` with fallback configuration | Configure fallback in `claude_args` or `settings` |
|
| `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"` |
|
| `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"` |
|
| `disallowed_tools` | **DEPRECATED**: Use `claude_args` with `--disallowedTools` instead | Use `claude_args: "--disallowedTools WebSearch"` |
|
||||||
|
| `mcp_config` | **DEPRECATED**: Use `claude_args` with `--mcp-config` instead | Use `claude_args: "--mcp-config '{...}'"` |
|
||||||
| `claude_env` | **DEPRECATED**: Use `settings` with env configuration | Configure environment in `settings` JSON |
|
| `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)
|
||||||
|
|||||||
@@ -22,7 +22,7 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout code
|
- name: Checkout code
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v5
|
||||||
with:
|
with:
|
||||||
ref: ${{ github.event.workflow_run.head_branch }}
|
ref: ${{ github.event.workflow_run.head_branch }}
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
|
|||||||
@@ -26,7 +26,7 @@ jobs:
|
|||||||
actions: read # Required for Claude to read CI results on PRs
|
actions: read # Required for Claude to read CI results on PRs
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout repository
|
- name: Checkout repository
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v5
|
||||||
with:
|
with:
|
||||||
fetch-depth: 1
|
fetch-depth: 1
|
||||||
|
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ jobs:
|
|||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout repository
|
- name: Checkout repository
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v5
|
||||||
with:
|
with:
|
||||||
fetch-depth: 1
|
fetch-depth: 1
|
||||||
|
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ jobs:
|
|||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout repository
|
- name: Checkout repository
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v5
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
|
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ jobs:
|
|||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout repository
|
- name: Checkout repository
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v5
|
||||||
with:
|
with:
|
||||||
fetch-depth: 2 # Need at least 2 commits to analyze the latest
|
fetch-depth: 2 # Need at least 2 commits to analyze the latest
|
||||||
|
|
||||||
|
|||||||
@@ -16,7 +16,7 @@ jobs:
|
|||||||
id-token: write
|
id-token: write
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout repository
|
- name: Checkout repository
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v5
|
||||||
with:
|
with:
|
||||||
fetch-depth: 1
|
fetch-depth: 1
|
||||||
|
|
||||||
|
|||||||
@@ -18,7 +18,7 @@ jobs:
|
|||||||
id-token: write
|
id-token: write
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout repository
|
- name: Checkout repository
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v5
|
||||||
with:
|
with:
|
||||||
fetch-depth: 1
|
fetch-depth: 1
|
||||||
|
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ jobs:
|
|||||||
id-token: write
|
id-token: write
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout repository
|
- name: Checkout repository
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v5
|
||||||
with:
|
with:
|
||||||
fetch-depth: 1
|
fetch-depth: 1
|
||||||
|
|
||||||
|
|||||||
27
github-app-manifest.json
Normal file
27
github-app-manifest.json
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
{
|
||||||
|
"name": "Claude Code Custom App",
|
||||||
|
"description": "Custom GitHub App for Claude Code Action - AI-powered coding assistant for GitHub workflows",
|
||||||
|
"url": "https://github.com/anthropics/claude-code-action",
|
||||||
|
"hook_attributes": {
|
||||||
|
"url": "https://example.com/github/webhook",
|
||||||
|
"active": false
|
||||||
|
},
|
||||||
|
"redirect_url": "https://github.com/settings/apps/new",
|
||||||
|
"callback_urls": [],
|
||||||
|
"setup_url": "https://github.com/anthropics/claude-code-action/blob/main/docs/setup.md",
|
||||||
|
"public": false,
|
||||||
|
"default_permissions": {
|
||||||
|
"contents": "write",
|
||||||
|
"issues": "write",
|
||||||
|
"pull_requests": "write",
|
||||||
|
"actions": "read",
|
||||||
|
"metadata": "read"
|
||||||
|
},
|
||||||
|
"default_events": [
|
||||||
|
"issue_comment",
|
||||||
|
"issues",
|
||||||
|
"pull_request",
|
||||||
|
"pull_request_review",
|
||||||
|
"pull_request_review_comment"
|
||||||
|
]
|
||||||
|
}
|
||||||
@@ -384,6 +384,7 @@ export function getEventTypeAndContext(envVars: PreparedContext): {
|
|||||||
};
|
};
|
||||||
|
|
||||||
case "pull_request":
|
case "pull_request":
|
||||||
|
case "pull_request_target":
|
||||||
return {
|
return {
|
||||||
eventType: "PULL_REQUEST",
|
eventType: "PULL_REQUEST",
|
||||||
triggerContext: eventData.eventAction
|
triggerContext: eventData.eventAction
|
||||||
@@ -683,7 +684,7 @@ ${
|
|||||||
- Display the todo list as a checklist in the GitHub comment and mark things off as you go.
|
- Display the todo list as a checklist in the GitHub comment and mark things off as you go.
|
||||||
- REPOSITORY SETUP INSTRUCTIONS: The repository's CLAUDE.md file(s) contain critical repo-specific setup instructions, development guidelines, and preferences. Always read and follow these files, particularly the root CLAUDE.md, as they provide essential context for working with the codebase effectively.
|
- REPOSITORY SETUP INSTRUCTIONS: The repository's CLAUDE.md file(s) contain critical repo-specific setup instructions, development guidelines, and preferences. Always read and follow these files, particularly the root CLAUDE.md, as they provide essential context for working with the codebase effectively.
|
||||||
- Use h3 headers (###) for section titles in your comments, not h1 headers (#).
|
- Use h3 headers (###) for section titles in your comments, not h1 headers (#).
|
||||||
- Your comment must always include the job run link (and branch link if there is one) at the bottom.
|
- Your comment must always include the job run link in the format "[View job run](${GITHUB_SERVER_URL}/${context.repository}/actions/runs/${process.env.GITHUB_RUN_ID})" at the bottom of your response (branch link if there is one should also be included there).
|
||||||
|
|
||||||
CAPABILITIES AND LIMITATIONS:
|
CAPABILITIES AND LIMITATIONS:
|
||||||
When users ask you to do something, be aware of what you can and cannot do. This section helps you understand how to respond when users request actions outside your scope.
|
When users ask you to do something, be aware of what you can and cannot do. This section helps you understand how to respond when users request actions outside your scope.
|
||||||
@@ -708,7 +709,7 @@ What You CANNOT Do:
|
|||||||
- Modify files in the .github/workflows directory (GitHub App permissions do not allow workflow modifications)
|
- Modify files in the .github/workflows directory (GitHub App permissions do not allow workflow modifications)
|
||||||
|
|
||||||
When users ask you to perform actions you cannot do, politely explain the limitation and, when applicable, direct them to the FAQ for more information and workarounds:
|
When users ask you to perform actions you cannot do, politely explain the limitation and, when applicable, direct them to the FAQ for more information and workarounds:
|
||||||
"I'm unable to [specific action] due to [reason]. You can find more information and potential workarounds in the [FAQ](https://github.com/anthropics/claude-code-action/blob/main/FAQ.md)."
|
"I'm unable to [specific action] due to [reason]. You can find more information and potential workarounds in the [FAQ](https://github.com/anthropics/claude-code-action/blob/main/docs/faq.md)."
|
||||||
|
|
||||||
If a user asks for something outside these capabilities (and you have no other tools provided), politely explain that you cannot perform that action and suggest an alternative approach if possible.
|
If a user asks for something outside these capabilities (and you have no other tools provided), politely explain that you cannot perform that action and suggest an alternative approach if possible.
|
||||||
|
|
||||||
|
|||||||
@@ -78,8 +78,7 @@ type IssueLabeledEvent = {
|
|||||||
labelTrigger: string;
|
labelTrigger: string;
|
||||||
};
|
};
|
||||||
|
|
||||||
type PullRequestEvent = {
|
type PullRequestBaseEvent = {
|
||||||
eventName: "pull_request";
|
|
||||||
eventAction?: string; // opened, synchronize, etc.
|
eventAction?: string; // opened, synchronize, etc.
|
||||||
isPR: true;
|
isPR: true;
|
||||||
prNumber: string;
|
prNumber: string;
|
||||||
@@ -87,6 +86,14 @@ type PullRequestEvent = {
|
|||||||
baseBranch?: string;
|
baseBranch?: string;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
type PullRequestEvent = PullRequestBaseEvent & {
|
||||||
|
eventName: "pull_request";
|
||||||
|
};
|
||||||
|
|
||||||
|
type PullRequestTargetEvent = PullRequestBaseEvent & {
|
||||||
|
eventName: "pull_request_target";
|
||||||
|
};
|
||||||
|
|
||||||
// Union type for all possible event types
|
// Union type for all possible event types
|
||||||
export type EventData =
|
export type EventData =
|
||||||
| PullRequestReviewCommentEvent
|
| PullRequestReviewCommentEvent
|
||||||
@@ -96,7 +103,8 @@ export type EventData =
|
|||||||
| IssueOpenedEvent
|
| IssueOpenedEvent
|
||||||
| IssueAssignedEvent
|
| IssueAssignedEvent
|
||||||
| IssueLabeledEvent
|
| IssueLabeledEvent
|
||||||
| PullRequestEvent;
|
| PullRequestEvent
|
||||||
|
| PullRequestTargetEvent;
|
||||||
|
|
||||||
// Combined type with separate eventData field
|
// Combined type with separate eventData field
|
||||||
export type PreparedContext = CommonFields & {
|
export type PreparedContext = CommonFields & {
|
||||||
|
|||||||
@@ -174,7 +174,8 @@ export function parseGitHubContext(): GitHubContext {
|
|||||||
isPR: Boolean(payload.issue.pull_request),
|
isPR: Boolean(payload.issue.pull_request),
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
case "pull_request": {
|
case "pull_request":
|
||||||
|
case "pull_request_target": {
|
||||||
const payload = context.payload as PullRequestEvent;
|
const payload = context.payload as PullRequestEvent;
|
||||||
return {
|
return {
|
||||||
...commonFields,
|
...commonFields,
|
||||||
|
|||||||
@@ -3,6 +3,7 @@ import { GITHUB_API_URL, GITHUB_SERVER_URL } from "../github/api/config";
|
|||||||
import type { GitHubContext } from "../github/context";
|
import type { GitHubContext } from "../github/context";
|
||||||
import { isEntityContext } from "../github/context";
|
import { isEntityContext } from "../github/context";
|
||||||
import { Octokit } from "@octokit/rest";
|
import { Octokit } from "@octokit/rest";
|
||||||
|
import type { AutoDetectedMode } from "../modes/detector";
|
||||||
|
|
||||||
type PrepareConfigParams = {
|
type PrepareConfigParams = {
|
||||||
githubToken: string;
|
githubToken: string;
|
||||||
@@ -12,8 +13,8 @@ type PrepareConfigParams = {
|
|||||||
baseBranch: string;
|
baseBranch: string;
|
||||||
claudeCommentId?: string;
|
claudeCommentId?: string;
|
||||||
allowedTools: string[];
|
allowedTools: string[];
|
||||||
|
mode: AutoDetectedMode;
|
||||||
context: GitHubContext;
|
context: GitHubContext;
|
||||||
mode: "tag" | "agent";
|
|
||||||
};
|
};
|
||||||
|
|
||||||
async function checkActionsReadPermission(
|
async function checkActionsReadPermission(
|
||||||
@@ -65,8 +66,13 @@ export async function prepareMcpConfig(
|
|||||||
try {
|
try {
|
||||||
const allowedToolsList = allowedTools || [];
|
const allowedToolsList = allowedTools || [];
|
||||||
|
|
||||||
|
// Detect if we're in agent mode (explicit prompt provided)
|
||||||
const isAgentMode = mode === "agent";
|
const isAgentMode = mode === "agent";
|
||||||
|
|
||||||
|
const hasGitHubCommentTools = allowedToolsList.some((tool) =>
|
||||||
|
tool.startsWith("mcp__github_comment__"),
|
||||||
|
);
|
||||||
|
|
||||||
const hasGitHubMcpTools = allowedToolsList.some((tool) =>
|
const hasGitHubMcpTools = allowedToolsList.some((tool) =>
|
||||||
tool.startsWith("mcp__github__"),
|
tool.startsWith("mcp__github__"),
|
||||||
);
|
);
|
||||||
@@ -86,7 +92,7 @@ export async function prepareMcpConfig(
|
|||||||
// Include comment server:
|
// Include comment server:
|
||||||
// - Always in tag mode (for updating Claude comments)
|
// - Always in tag mode (for updating Claude comments)
|
||||||
// - Only with explicit tools in agent mode
|
// - Only with explicit tools in agent mode
|
||||||
const shouldIncludeCommentServer = !isAgentMode;
|
const shouldIncludeCommentServer = !isAgentMode || hasGitHubCommentTools;
|
||||||
|
|
||||||
if (shouldIncludeCommentServer) {
|
if (shouldIncludeCommentServer) {
|
||||||
baseMcpConfig.mcpServers.github_comment = {
|
baseMcpConfig.mcpServers.github_comment = {
|
||||||
@@ -203,7 +209,7 @@ export async function prepareMcpConfig(
|
|||||||
"GITHUB_PERSONAL_ACCESS_TOKEN",
|
"GITHUB_PERSONAL_ACCESS_TOKEN",
|
||||||
"-e",
|
"-e",
|
||||||
"GITHUB_HOST",
|
"GITHUB_HOST",
|
||||||
"ghcr.io/github/github-mcp-server:sha-efef8ae", // https://github.com/github/github-mcp-server/releases/tag/v0.9.0
|
"ghcr.io/github/github-mcp-server:sha-23fa0dd", // https://github.com/github/github-mcp-server/releases/tag/v0.17.1
|
||||||
],
|
],
|
||||||
env: {
|
env: {
|
||||||
GITHUB_PERSONAL_ACCESS_TOKEN: githubToken,
|
GITHUB_PERSONAL_ACCESS_TOKEN: githubToken,
|
||||||
|
|||||||
@@ -135,8 +135,8 @@ export const agentMode: Mode = {
|
|||||||
baseBranch: baseBranch,
|
baseBranch: baseBranch,
|
||||||
claudeCommentId: undefined, // No tracking comment in agent mode
|
claudeCommentId: undefined, // No tracking comment in agent mode
|
||||||
allowedTools,
|
allowedTools,
|
||||||
context,
|
|
||||||
mode: "agent",
|
mode: "agent",
|
||||||
|
context,
|
||||||
});
|
});
|
||||||
|
|
||||||
// Build final claude_args with multiple --mcp-config flags
|
// Build final claude_args with multiple --mcp-config flags
|
||||||
|
|||||||
@@ -1,10 +1,10 @@
|
|||||||
export function parseAllowedTools(claudeArgs: string): string[] {
|
export function parseAllowedTools(claudeArgs: string): string[] {
|
||||||
// Match --allowedTools followed by the value
|
// Match --allowedTools or --allowed-tools followed by the value
|
||||||
// Handle both quoted and unquoted values
|
// Handle both quoted and unquoted values
|
||||||
const patterns = [
|
const patterns = [
|
||||||
/--allowedTools\s+"([^"]+)"/, // Double quoted
|
/--(?:allowedTools|allowed-tools)\s+"([^"]+)"/, // Double quoted
|
||||||
/--allowedTools\s+'([^']+)'/, // Single quoted
|
/--(?:allowedTools|allowed-tools)\s+'([^']+)'/, // Single quoted
|
||||||
/--allowedTools\s+([^\s]+)/, // Unquoted
|
/--(?:allowedTools|allowed-tools)\s+([^\s]+)/, // Unquoted
|
||||||
];
|
];
|
||||||
|
|
||||||
for (const pattern of patterns) {
|
for (const pattern of patterns) {
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ import { createPrompt, generateDefaultPrompt } from "../../create-prompt";
|
|||||||
import { isEntityContext } from "../../github/context";
|
import { isEntityContext } from "../../github/context";
|
||||||
import type { PreparedContext } from "../../create-prompt/types";
|
import type { PreparedContext } from "../../create-prompt/types";
|
||||||
import type { FetchDataResult } from "../../github/data/fetcher";
|
import type { FetchDataResult } from "../../github/data/fetcher";
|
||||||
|
import { parseAllowedTools } from "../agent/parse-tools";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Tag mode implementation.
|
* Tag mode implementation.
|
||||||
@@ -112,20 +113,10 @@ export const tagMode: Mode = {
|
|||||||
|
|
||||||
await createPrompt(tagMode, modeContext, githubData, context);
|
await createPrompt(tagMode, modeContext, githubData, context);
|
||||||
|
|
||||||
// Get our GitHub MCP servers configuration
|
const userClaudeArgs = process.env.CLAUDE_ARGS || "";
|
||||||
const ourMcpConfig = await prepareMcpConfig({
|
const userAllowedMCPTools = parseAllowedTools(userClaudeArgs).filter(
|
||||||
githubToken,
|
(tool) => tool.startsWith("mcp__github_"),
|
||||||
owner: context.repository.owner,
|
);
|
||||||
repo: context.repository.repo,
|
|
||||||
branch: branchInfo.claudeBranch || branchInfo.currentBranch,
|
|
||||||
baseBranch: branchInfo.baseBranch,
|
|
||||||
claudeCommentId: commentId.toString(),
|
|
||||||
allowedTools: [],
|
|
||||||
context,
|
|
||||||
mode: "tag",
|
|
||||||
});
|
|
||||||
|
|
||||||
// Don't output mcp_config separately anymore - include in claude_args
|
|
||||||
|
|
||||||
// Build claude_args for tag mode with required tools
|
// Build claude_args for tag mode with required tools
|
||||||
// Tag mode REQUIRES these tools to function properly
|
// Tag mode REQUIRES these tools to function properly
|
||||||
@@ -141,6 +132,7 @@ export const tagMode: Mode = {
|
|||||||
"mcp__github_ci__get_ci_status",
|
"mcp__github_ci__get_ci_status",
|
||||||
"mcp__github_ci__get_workflow_run_details",
|
"mcp__github_ci__get_workflow_run_details",
|
||||||
"mcp__github_ci__download_job_log",
|
"mcp__github_ci__download_job_log",
|
||||||
|
...userAllowedMCPTools,
|
||||||
];
|
];
|
||||||
|
|
||||||
// Add git commands when not using commit signing
|
// Add git commands when not using commit signing
|
||||||
@@ -162,7 +154,18 @@ export const tagMode: Mode = {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
const userClaudeArgs = process.env.CLAUDE_ARGS || "";
|
// Get our GitHub MCP servers configuration
|
||||||
|
const ourMcpConfig = await prepareMcpConfig({
|
||||||
|
githubToken,
|
||||||
|
owner: context.repository.owner,
|
||||||
|
repo: context.repository.repo,
|
||||||
|
branch: branchInfo.claudeBranch || branchInfo.currentBranch,
|
||||||
|
baseBranch: branchInfo.baseBranch,
|
||||||
|
claudeCommentId: commentId.toString(),
|
||||||
|
allowedTools: Array.from(new Set(tagModeTools)),
|
||||||
|
mode: "tag",
|
||||||
|
context,
|
||||||
|
});
|
||||||
|
|
||||||
// Build complete claude_args with multiple --mcp-config flags
|
// Build complete claude_args with multiple --mcp-config flags
|
||||||
let claudeArgs = "";
|
let claudeArgs = "";
|
||||||
|
|||||||
@@ -106,8 +106,8 @@ describe("prepareMcpConfig", () => {
|
|||||||
branch: "test-branch",
|
branch: "test-branch",
|
||||||
baseBranch: "main",
|
baseBranch: "main",
|
||||||
allowedTools: [],
|
allowedTools: [],
|
||||||
context: mockContextWithSigning,
|
|
||||||
mode: "tag",
|
mode: "tag",
|
||||||
|
context: mockContextWithSigning,
|
||||||
});
|
});
|
||||||
|
|
||||||
const parsed = JSON.parse(result);
|
const parsed = JSON.parse(result);
|
||||||
@@ -130,8 +130,8 @@ describe("prepareMcpConfig", () => {
|
|||||||
branch: "test-branch",
|
branch: "test-branch",
|
||||||
baseBranch: "main",
|
baseBranch: "main",
|
||||||
allowedTools: ["mcp__github__create_issue", "mcp__github__create_pr"],
|
allowedTools: ["mcp__github__create_issue", "mcp__github__create_pr"],
|
||||||
context: mockContext,
|
|
||||||
mode: "tag",
|
mode: "tag",
|
||||||
|
context: mockContext,
|
||||||
});
|
});
|
||||||
|
|
||||||
const parsed = JSON.parse(result);
|
const parsed = JSON.parse(result);
|
||||||
@@ -151,8 +151,8 @@ describe("prepareMcpConfig", () => {
|
|||||||
branch: "test-branch",
|
branch: "test-branch",
|
||||||
baseBranch: "main",
|
baseBranch: "main",
|
||||||
allowedTools: ["mcp__github_inline_comment__create_inline_comment"],
|
allowedTools: ["mcp__github_inline_comment__create_inline_comment"],
|
||||||
context: mockPRContext,
|
|
||||||
mode: "tag",
|
mode: "tag",
|
||||||
|
context: mockPRContext,
|
||||||
});
|
});
|
||||||
|
|
||||||
const parsed = JSON.parse(result);
|
const parsed = JSON.parse(result);
|
||||||
@@ -172,8 +172,8 @@ describe("prepareMcpConfig", () => {
|
|||||||
branch: "test-branch",
|
branch: "test-branch",
|
||||||
baseBranch: "main",
|
baseBranch: "main",
|
||||||
allowedTools: [],
|
allowedTools: [],
|
||||||
context: mockContext,
|
|
||||||
mode: "tag",
|
mode: "tag",
|
||||||
|
context: mockContext,
|
||||||
});
|
});
|
||||||
|
|
||||||
const parsed = JSON.parse(result);
|
const parsed = JSON.parse(result);
|
||||||
@@ -193,8 +193,8 @@ describe("prepareMcpConfig", () => {
|
|||||||
branch: "test-branch",
|
branch: "test-branch",
|
||||||
baseBranch: "main",
|
baseBranch: "main",
|
||||||
allowedTools: [],
|
allowedTools: [],
|
||||||
context: mockContextWithSigning,
|
|
||||||
mode: "tag",
|
mode: "tag",
|
||||||
|
context: mockContextWithSigning,
|
||||||
});
|
});
|
||||||
|
|
||||||
const parsed = JSON.parse(result);
|
const parsed = JSON.parse(result);
|
||||||
@@ -213,8 +213,8 @@ describe("prepareMcpConfig", () => {
|
|||||||
branch: "test-branch",
|
branch: "test-branch",
|
||||||
baseBranch: "main",
|
baseBranch: "main",
|
||||||
allowedTools: [],
|
allowedTools: [],
|
||||||
context: mockContextWithSigning,
|
|
||||||
mode: "tag",
|
mode: "tag",
|
||||||
|
context: mockContextWithSigning,
|
||||||
});
|
});
|
||||||
|
|
||||||
const parsed = JSON.parse(result);
|
const parsed = JSON.parse(result);
|
||||||
@@ -231,8 +231,8 @@ describe("prepareMcpConfig", () => {
|
|||||||
branch: "test-branch",
|
branch: "test-branch",
|
||||||
baseBranch: "main",
|
baseBranch: "main",
|
||||||
allowedTools: [],
|
allowedTools: [],
|
||||||
context: mockPRContext,
|
|
||||||
mode: "tag",
|
mode: "tag",
|
||||||
|
context: mockPRContext,
|
||||||
});
|
});
|
||||||
|
|
||||||
const parsed = JSON.parse(result);
|
const parsed = JSON.parse(result);
|
||||||
@@ -251,8 +251,8 @@ describe("prepareMcpConfig", () => {
|
|||||||
branch: "test-branch",
|
branch: "test-branch",
|
||||||
baseBranch: "main",
|
baseBranch: "main",
|
||||||
allowedTools: [],
|
allowedTools: [],
|
||||||
context: mockContext,
|
|
||||||
mode: "tag",
|
mode: "tag",
|
||||||
|
context: mockContext,
|
||||||
});
|
});
|
||||||
|
|
||||||
const parsed = JSON.parse(result);
|
const parsed = JSON.parse(result);
|
||||||
@@ -269,8 +269,8 @@ describe("prepareMcpConfig", () => {
|
|||||||
branch: "test-branch",
|
branch: "test-branch",
|
||||||
baseBranch: "main",
|
baseBranch: "main",
|
||||||
allowedTools: [],
|
allowedTools: [],
|
||||||
context: mockPRContext,
|
|
||||||
mode: "tag",
|
mode: "tag",
|
||||||
|
context: mockPRContext,
|
||||||
});
|
});
|
||||||
|
|
||||||
const parsed = JSON.parse(result);
|
const parsed = JSON.parse(result);
|
||||||
|
|||||||
@@ -68,4 +68,20 @@ describe("parseAllowedTools", () => {
|
|||||||
"mcp__github_comment__update",
|
"mcp__github_comment__update",
|
||||||
]);
|
]);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
test("parses kebab-case --allowed-tools", () => {
|
||||||
|
const args = "--allowed-tools mcp__github__*,mcp__github_comment__*";
|
||||||
|
expect(parseAllowedTools(args)).toEqual([
|
||||||
|
"mcp__github__*",
|
||||||
|
"mcp__github_comment__*",
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("parses quoted kebab-case --allowed-tools", () => {
|
||||||
|
const args = '--allowed-tools "mcp__github__*,mcp__github_comment__*"';
|
||||||
|
expect(parseAllowedTools(args)).toEqual([
|
||||||
|
"mcp__github__*",
|
||||||
|
"mcp__github_comment__*",
|
||||||
|
]);
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
504
test/pull-request-target.test.ts
Normal file
504
test/pull-request-target.test.ts
Normal file
@@ -0,0 +1,504 @@
|
|||||||
|
#!/usr/bin/env bun
|
||||||
|
|
||||||
|
import { describe, test, expect } from "bun:test";
|
||||||
|
import {
|
||||||
|
getEventTypeAndContext,
|
||||||
|
generatePrompt,
|
||||||
|
generateDefaultPrompt,
|
||||||
|
} from "../src/create-prompt";
|
||||||
|
import type { PreparedContext } from "../src/create-prompt";
|
||||||
|
import type { Mode } from "../src/modes/types";
|
||||||
|
|
||||||
|
describe("pull_request_target event support", () => {
|
||||||
|
// Mock tag mode for testing
|
||||||
|
const mockTagMode: Mode = {
|
||||||
|
name: "tag",
|
||||||
|
description: "Tag mode",
|
||||||
|
shouldTrigger: () => true,
|
||||||
|
prepareContext: (context) => ({ mode: "tag", githubContext: context }),
|
||||||
|
getAllowedTools: () => [],
|
||||||
|
getDisallowedTools: () => [],
|
||||||
|
shouldCreateTrackingComment: () => true,
|
||||||
|
generatePrompt: (context, githubData, useCommitSigning) =>
|
||||||
|
generateDefaultPrompt(context, githubData, useCommitSigning),
|
||||||
|
prepare: async () => ({
|
||||||
|
commentId: 123,
|
||||||
|
branchInfo: {
|
||||||
|
baseBranch: "main",
|
||||||
|
currentBranch: "main",
|
||||||
|
claudeBranch: undefined,
|
||||||
|
},
|
||||||
|
mcpConfig: "{}",
|
||||||
|
}),
|
||||||
|
};
|
||||||
|
|
||||||
|
const mockGitHubData = {
|
||||||
|
contextData: {
|
||||||
|
title: "External PR via pull_request_target",
|
||||||
|
body: "This PR comes from a forked repository",
|
||||||
|
author: { login: "external-contributor" },
|
||||||
|
state: "OPEN",
|
||||||
|
createdAt: "2023-01-01T00:00:00Z",
|
||||||
|
additions: 25,
|
||||||
|
deletions: 3,
|
||||||
|
baseRefName: "main",
|
||||||
|
headRefName: "feature-branch",
|
||||||
|
headRefOid: "abc123",
|
||||||
|
commits: {
|
||||||
|
totalCount: 2,
|
||||||
|
nodes: [
|
||||||
|
{
|
||||||
|
commit: {
|
||||||
|
oid: "commit1",
|
||||||
|
message: "Initial feature implementation",
|
||||||
|
author: {
|
||||||
|
name: "External Dev",
|
||||||
|
email: "external@example.com",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
commit: {
|
||||||
|
oid: "commit2",
|
||||||
|
message: "Fix typos and formatting",
|
||||||
|
author: {
|
||||||
|
name: "External Dev",
|
||||||
|
email: "external@example.com",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
files: {
|
||||||
|
nodes: [
|
||||||
|
{
|
||||||
|
path: "src/feature.ts",
|
||||||
|
additions: 20,
|
||||||
|
deletions: 2,
|
||||||
|
changeType: "MODIFIED",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
path: "tests/feature.test.ts",
|
||||||
|
additions: 5,
|
||||||
|
deletions: 1,
|
||||||
|
changeType: "ADDED",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
comments: { nodes: [] },
|
||||||
|
reviews: { nodes: [] },
|
||||||
|
},
|
||||||
|
comments: [],
|
||||||
|
changedFiles: [],
|
||||||
|
changedFilesWithSHA: [
|
||||||
|
{
|
||||||
|
path: "src/feature.ts",
|
||||||
|
additions: 20,
|
||||||
|
deletions: 2,
|
||||||
|
changeType: "MODIFIED",
|
||||||
|
sha: "abc123",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
path: "tests/feature.test.ts",
|
||||||
|
additions: 5,
|
||||||
|
deletions: 1,
|
||||||
|
changeType: "ADDED",
|
||||||
|
sha: "abc123",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
reviewData: { nodes: [] },
|
||||||
|
imageUrlMap: new Map<string, string>(),
|
||||||
|
};
|
||||||
|
|
||||||
|
describe("prompt generation for pull_request_target", () => {
|
||||||
|
test("should generate correct prompt for pull_request_target event", () => {
|
||||||
|
const envVars: PreparedContext = {
|
||||||
|
repository: "owner/repo",
|
||||||
|
claudeCommentId: "12345",
|
||||||
|
triggerPhrase: "@claude",
|
||||||
|
eventData: {
|
||||||
|
eventName: "pull_request_target",
|
||||||
|
eventAction: "opened",
|
||||||
|
isPR: true,
|
||||||
|
prNumber: "123",
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
const prompt = generatePrompt(
|
||||||
|
envVars,
|
||||||
|
mockGitHubData,
|
||||||
|
false,
|
||||||
|
mockTagMode,
|
||||||
|
);
|
||||||
|
|
||||||
|
// Should contain pull request event type and metadata
|
||||||
|
expect(prompt).toContain("<event_type>PULL_REQUEST</event_type>");
|
||||||
|
expect(prompt).toContain("<is_pr>true</is_pr>");
|
||||||
|
expect(prompt).toContain("<pr_number>123</pr_number>");
|
||||||
|
expect(prompt).toContain(
|
||||||
|
"<trigger_context>pull request opened</trigger_context>",
|
||||||
|
);
|
||||||
|
|
||||||
|
// Should contain PR-specific information
|
||||||
|
expect(prompt).toContain(
|
||||||
|
"- src/feature.ts (MODIFIED) +20/-2 SHA: abc123",
|
||||||
|
);
|
||||||
|
expect(prompt).toContain(
|
||||||
|
"- tests/feature.test.ts (ADDED) +5/-1 SHA: abc123",
|
||||||
|
);
|
||||||
|
expect(prompt).toContain("external-contributor");
|
||||||
|
expect(prompt).toContain("<repository>owner/repo</repository>");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should handle pull_request_target with commit signing disabled", () => {
|
||||||
|
const envVars: PreparedContext = {
|
||||||
|
repository: "owner/repo",
|
||||||
|
claudeCommentId: "12345",
|
||||||
|
triggerPhrase: "@claude",
|
||||||
|
eventData: {
|
||||||
|
eventName: "pull_request_target",
|
||||||
|
eventAction: "synchronize",
|
||||||
|
isPR: true,
|
||||||
|
prNumber: "456",
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
const prompt = generatePrompt(
|
||||||
|
envVars,
|
||||||
|
mockGitHubData,
|
||||||
|
false,
|
||||||
|
mockTagMode,
|
||||||
|
);
|
||||||
|
|
||||||
|
// Should include git commands for non-commit-signing mode
|
||||||
|
expect(prompt).toContain("git push");
|
||||||
|
expect(prompt).toContain(
|
||||||
|
"Always push to the existing branch when triggered on a PR",
|
||||||
|
);
|
||||||
|
expect(prompt).toContain("mcp__github_comment__update_claude_comment");
|
||||||
|
|
||||||
|
// Should not include commit signing tools
|
||||||
|
expect(prompt).not.toContain("mcp__github_file_ops__commit_files");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should handle pull_request_target with commit signing enabled", () => {
|
||||||
|
const envVars: PreparedContext = {
|
||||||
|
repository: "owner/repo",
|
||||||
|
claudeCommentId: "12345",
|
||||||
|
triggerPhrase: "@claude",
|
||||||
|
eventData: {
|
||||||
|
eventName: "pull_request_target",
|
||||||
|
eventAction: "synchronize",
|
||||||
|
isPR: true,
|
||||||
|
prNumber: "456",
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
const prompt = generatePrompt(envVars, mockGitHubData, true, mockTagMode);
|
||||||
|
|
||||||
|
// Should include commit signing tools
|
||||||
|
expect(prompt).toContain("mcp__github_file_ops__commit_files");
|
||||||
|
expect(prompt).toContain("mcp__github_file_ops__delete_files");
|
||||||
|
expect(prompt).toContain("mcp__github_comment__update_claude_comment");
|
||||||
|
|
||||||
|
// Should not include git command instructions
|
||||||
|
expect(prompt).not.toContain("Use git commands via the Bash tool");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should treat pull_request_target same as pull_request in prompt generation", () => {
|
||||||
|
const baseContext: PreparedContext = {
|
||||||
|
repository: "owner/repo",
|
||||||
|
claudeCommentId: "12345",
|
||||||
|
triggerPhrase: "@claude",
|
||||||
|
eventData: {
|
||||||
|
eventName: "pull_request_target",
|
||||||
|
eventAction: "opened",
|
||||||
|
isPR: true,
|
||||||
|
prNumber: "123",
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
// Generate prompt for pull_request
|
||||||
|
const pullRequestContext: PreparedContext = {
|
||||||
|
...baseContext,
|
||||||
|
eventData: {
|
||||||
|
...baseContext.eventData,
|
||||||
|
eventName: "pull_request",
|
||||||
|
isPR: true,
|
||||||
|
prNumber: "123",
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
// Generate prompt for pull_request_target
|
||||||
|
const pullRequestTargetContext: PreparedContext = {
|
||||||
|
...baseContext,
|
||||||
|
eventData: {
|
||||||
|
...baseContext.eventData,
|
||||||
|
eventName: "pull_request_target",
|
||||||
|
isPR: true,
|
||||||
|
prNumber: "123",
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
const pullRequestPrompt = generatePrompt(
|
||||||
|
pullRequestContext,
|
||||||
|
mockGitHubData,
|
||||||
|
false,
|
||||||
|
mockTagMode,
|
||||||
|
);
|
||||||
|
const pullRequestTargetPrompt = generatePrompt(
|
||||||
|
pullRequestTargetContext,
|
||||||
|
mockGitHubData,
|
||||||
|
false,
|
||||||
|
mockTagMode,
|
||||||
|
);
|
||||||
|
|
||||||
|
// Both should have the same event type and structure
|
||||||
|
expect(pullRequestPrompt).toContain(
|
||||||
|
"<event_type>PULL_REQUEST</event_type>",
|
||||||
|
);
|
||||||
|
expect(pullRequestTargetPrompt).toContain(
|
||||||
|
"<event_type>PULL_REQUEST</event_type>",
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(pullRequestPrompt).toContain(
|
||||||
|
"<trigger_context>pull request opened</trigger_context>",
|
||||||
|
);
|
||||||
|
expect(pullRequestTargetPrompt).toContain(
|
||||||
|
"<trigger_context>pull request opened</trigger_context>",
|
||||||
|
);
|
||||||
|
|
||||||
|
// Both should contain PR-specific instructions
|
||||||
|
expect(pullRequestPrompt).toContain(
|
||||||
|
"Always push to the existing branch when triggered on a PR",
|
||||||
|
);
|
||||||
|
expect(pullRequestTargetPrompt).toContain(
|
||||||
|
"Always push to the existing branch when triggered on a PR",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should handle pull_request_target in agent mode with custom prompt", () => {
|
||||||
|
const envVars: PreparedContext = {
|
||||||
|
repository: "test/repo",
|
||||||
|
claudeCommentId: "12345",
|
||||||
|
triggerPhrase: "@claude",
|
||||||
|
prompt: "Review this pull_request_target PR for security issues",
|
||||||
|
eventData: {
|
||||||
|
eventName: "pull_request_target",
|
||||||
|
eventAction: "opened",
|
||||||
|
isPR: true,
|
||||||
|
prNumber: "789",
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
// Use agent mode which passes through the prompt as-is
|
||||||
|
const mockAgentMode: Mode = {
|
||||||
|
name: "agent",
|
||||||
|
description: "Agent mode",
|
||||||
|
shouldTrigger: () => true,
|
||||||
|
prepareContext: (context) => ({
|
||||||
|
mode: "agent",
|
||||||
|
githubContext: context,
|
||||||
|
}),
|
||||||
|
getAllowedTools: () => [],
|
||||||
|
getDisallowedTools: () => [],
|
||||||
|
shouldCreateTrackingComment: () => true,
|
||||||
|
generatePrompt: (context) => context.prompt || "default prompt",
|
||||||
|
prepare: async () => ({
|
||||||
|
commentId: 123,
|
||||||
|
branchInfo: {
|
||||||
|
baseBranch: "main",
|
||||||
|
currentBranch: "main",
|
||||||
|
claudeBranch: undefined,
|
||||||
|
},
|
||||||
|
mcpConfig: "{}",
|
||||||
|
}),
|
||||||
|
};
|
||||||
|
|
||||||
|
const prompt = generatePrompt(
|
||||||
|
envVars,
|
||||||
|
mockGitHubData,
|
||||||
|
false,
|
||||||
|
mockAgentMode,
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(prompt).toBe(
|
||||||
|
"Review this pull_request_target PR for security issues",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should handle pull_request_target with no custom prompt", () => {
|
||||||
|
const envVars: PreparedContext = {
|
||||||
|
repository: "test/repo",
|
||||||
|
claudeCommentId: "12345",
|
||||||
|
triggerPhrase: "@claude",
|
||||||
|
eventData: {
|
||||||
|
eventName: "pull_request_target",
|
||||||
|
eventAction: "synchronize",
|
||||||
|
isPR: true,
|
||||||
|
prNumber: "456",
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
const prompt = generatePrompt(
|
||||||
|
envVars,
|
||||||
|
mockGitHubData,
|
||||||
|
false,
|
||||||
|
mockTagMode,
|
||||||
|
);
|
||||||
|
|
||||||
|
// Should generate default prompt structure
|
||||||
|
expect(prompt).toContain("<event_type>PULL_REQUEST</event_type>");
|
||||||
|
expect(prompt).toContain("<pr_number>456</pr_number>");
|
||||||
|
expect(prompt).toContain(
|
||||||
|
"Always push to the existing branch when triggered on a PR",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("pull_request_target vs pull_request behavior consistency", () => {
|
||||||
|
test("should produce identical event processing for both event types", () => {
|
||||||
|
const baseEventData = {
|
||||||
|
eventAction: "opened",
|
||||||
|
isPR: true,
|
||||||
|
prNumber: "100",
|
||||||
|
};
|
||||||
|
|
||||||
|
const pullRequestEvent: PreparedContext = {
|
||||||
|
repository: "owner/repo",
|
||||||
|
claudeCommentId: "12345",
|
||||||
|
triggerPhrase: "@claude",
|
||||||
|
eventData: {
|
||||||
|
...baseEventData,
|
||||||
|
eventName: "pull_request",
|
||||||
|
isPR: true,
|
||||||
|
prNumber: "100",
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
const pullRequestTargetEvent: PreparedContext = {
|
||||||
|
repository: "owner/repo",
|
||||||
|
claudeCommentId: "12345",
|
||||||
|
triggerPhrase: "@claude",
|
||||||
|
eventData: {
|
||||||
|
...baseEventData,
|
||||||
|
eventName: "pull_request_target",
|
||||||
|
isPR: true,
|
||||||
|
prNumber: "100",
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
// Both should have identical event type detection
|
||||||
|
const prResult = getEventTypeAndContext(pullRequestEvent);
|
||||||
|
const prtResult = getEventTypeAndContext(pullRequestTargetEvent);
|
||||||
|
|
||||||
|
expect(prResult.eventType).toBe(prtResult.eventType);
|
||||||
|
expect(prResult.triggerContext).toBe(prtResult.triggerContext);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should handle edge cases in pull_request_target events", () => {
|
||||||
|
// Test with minimal event data
|
||||||
|
const minimalContext: PreparedContext = {
|
||||||
|
repository: "owner/repo",
|
||||||
|
claudeCommentId: "12345",
|
||||||
|
triggerPhrase: "@claude",
|
||||||
|
eventData: {
|
||||||
|
eventName: "pull_request_target",
|
||||||
|
isPR: true,
|
||||||
|
prNumber: "1",
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
const result = getEventTypeAndContext(minimalContext);
|
||||||
|
expect(result.eventType).toBe("PULL_REQUEST");
|
||||||
|
expect(result.triggerContext).toBe("pull request event");
|
||||||
|
|
||||||
|
// Should not throw when generating prompt
|
||||||
|
expect(() => {
|
||||||
|
generatePrompt(minimalContext, mockGitHubData, false, mockTagMode);
|
||||||
|
}).not.toThrow();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("should handle all valid pull_request_target actions", () => {
|
||||||
|
const actions = ["opened", "synchronize", "reopened", "closed", "edited"];
|
||||||
|
|
||||||
|
actions.forEach((action) => {
|
||||||
|
const context: PreparedContext = {
|
||||||
|
repository: "owner/repo",
|
||||||
|
claudeCommentId: "12345",
|
||||||
|
triggerPhrase: "@claude",
|
||||||
|
eventData: {
|
||||||
|
eventName: "pull_request_target",
|
||||||
|
eventAction: action,
|
||||||
|
isPR: true,
|
||||||
|
prNumber: "1",
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
const result = getEventTypeAndContext(context);
|
||||||
|
expect(result.eventType).toBe("PULL_REQUEST");
|
||||||
|
expect(result.triggerContext).toBe(`pull request ${action}`);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("security considerations for pull_request_target", () => {
|
||||||
|
test("should maintain same prompt structure regardless of event source", () => {
|
||||||
|
// Test that external PRs don't get different treatment in prompts
|
||||||
|
const internalPR: PreparedContext = {
|
||||||
|
repository: "owner/repo",
|
||||||
|
claudeCommentId: "12345",
|
||||||
|
triggerPhrase: "@claude",
|
||||||
|
eventData: {
|
||||||
|
eventName: "pull_request",
|
||||||
|
eventAction: "opened",
|
||||||
|
isPR: true,
|
||||||
|
prNumber: "1",
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
const externalPR: PreparedContext = {
|
||||||
|
repository: "owner/repo",
|
||||||
|
claudeCommentId: "12345",
|
||||||
|
triggerPhrase: "@claude",
|
||||||
|
eventData: {
|
||||||
|
eventName: "pull_request_target",
|
||||||
|
eventAction: "opened",
|
||||||
|
isPR: true,
|
||||||
|
prNumber: "1",
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
const internalPrompt = generatePrompt(
|
||||||
|
internalPR,
|
||||||
|
mockGitHubData,
|
||||||
|
false,
|
||||||
|
mockTagMode,
|
||||||
|
);
|
||||||
|
const externalPrompt = generatePrompt(
|
||||||
|
externalPR,
|
||||||
|
mockGitHubData,
|
||||||
|
false,
|
||||||
|
mockTagMode,
|
||||||
|
);
|
||||||
|
|
||||||
|
// Should have same tool access patterns
|
||||||
|
expect(
|
||||||
|
internalPrompt.includes("mcp__github_comment__update_claude_comment"),
|
||||||
|
).toBe(
|
||||||
|
externalPrompt.includes("mcp__github_comment__update_claude_comment"),
|
||||||
|
);
|
||||||
|
|
||||||
|
// Should have same branch handling instructions
|
||||||
|
expect(
|
||||||
|
internalPrompt.includes(
|
||||||
|
"Always push to the existing branch when triggered on a PR",
|
||||||
|
),
|
||||||
|
).toBe(
|
||||||
|
externalPrompt.includes(
|
||||||
|
"Always push to the existing branch when triggered on a PR",
|
||||||
|
),
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
Reference in New Issue
Block a user