| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144 |
- export const PR_TITLE = 'Add Claude Code GitHub Workflow'
- export const GITHUB_ACTION_SETUP_DOCS_URL =
- 'https://github.com/anthropics/claude-code-action/blob/main/docs/setup.md'
- export const WORKFLOW_CONTENT = `name: Claude Code
- 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: read
- pull-requests: read
- issues: read
- id-token: write
- actions: read # Required for Claude to read CI results on PRs
- steps:
- - name: Checkout repository
- uses: actions/checkout@v4
- with:
- fetch-depth: 1
- - name: Run Claude Code
- id: claude
- uses: anthropics/claude-code-action@v1
- with:
- anthropic_api_key: \${{ secrets.ANTHROPIC_API_KEY }}
- # This is an optional setting that allows Claude to read CI results on PRs
- additional_permissions: |
- actions: read
- # Optional: Give a custom prompt to Claude. If this is not specified, Claude will perform the instructions specified in the comment that tagged it.
- # prompt: 'Update the pull request description to include a summary of changes.'
- # Optional: Add claude_args to customize behavior and configuration
- # See https://github.com/anthropics/claude-code-action/blob/main/docs/usage.md
- # or https://code.claude.com/docs/en/cli-reference for available options
- # claude_args: '--allowed-tools Bash(gh pr:*)'
- `
- export const PR_BODY = `## 🤖 Installing Claude Code GitHub App
- This PR adds a GitHub Actions workflow that enables Claude Code integration in our repository.
- ### What is Claude Code?
- [Claude Code](https://claude.com/claude-code) is an AI coding agent that can help with:
- - Bug fixes and improvements
- - Documentation updates
- - Implementing new features
- - Code reviews and suggestions
- - Writing tests
- - And more!
- ### How it works
- Once this PR is merged, we'll be able to interact with Claude by mentioning @claude in a pull request or issue comment.
- Once the workflow is triggered, Claude will analyze the comment and surrounding context, and execute on the request in a GitHub action.
- ### Important Notes
- - **This workflow won't take effect until this PR is merged**
- - **@claude mentions won't work until after the merge is complete**
- - The workflow runs automatically whenever Claude is mentioned in PR or issue comments
- - Claude gets access to the entire PR or issue context including files, diffs, and previous comments
- ### Security
- - Our Anthropic API key is securely stored as a GitHub Actions secret
- - Only users with write access to the repository can trigger the workflow
- - All Claude runs are stored in the GitHub Actions run history
- - Claude's default tools are limited to reading/writing files and interacting with our repo by creating comments, branches, and commits.
- - We can add more allowed tools by adding them to the workflow file like:
- \`\`\`
- allowed_tools: Bash(npm install),Bash(npm run build),Bash(npm run lint),Bash(npm run test)
- \`\`\`
- There's more information in the [Claude Code action repo](https://github.com/anthropics/claude-code-action).
- After merging this PR, let's try mentioning @claude in a comment on any PR to get started!`
- export const CODE_REVIEW_PLUGIN_WORKFLOW_CONTENT = `name: Claude Code Review
- on:
- pull_request:
- types: [opened, synchronize, ready_for_review, reopened]
- # Optional: Only run on specific file changes
- # paths:
- # - "src/**/*.ts"
- # - "src/**/*.tsx"
- # - "src/**/*.js"
- # - "src/**/*.jsx"
- jobs:
- claude-review:
- # Optional: Filter by PR author
- # if: |
- # github.event.pull_request.user.login == 'external-contributor' ||
- # github.event.pull_request.user.login == 'new-developer' ||
- # github.event.pull_request.author_association == 'FIRST_TIME_CONTRIBUTOR'
- runs-on: ubuntu-latest
- permissions:
- contents: read
- pull-requests: read
- issues: read
- id-token: write
- steps:
- - name: Checkout repository
- uses: actions/checkout@v4
- with:
- fetch-depth: 1
- - name: Run Claude Code Review
- id: claude-review
- uses: anthropics/claude-code-action@v1
- with:
- anthropic_api_key: \${{ secrets.ANTHROPIC_API_KEY }}
- plugin_marketplaces: 'https://github.com/anthropics/claude-code.git'
- plugins: 'code-review@claude-code-plugins'
- prompt: '/code-review:code-review \${{ github.repository }}/pull/\${{ github.event.pull_request.number }}'
- # See https://github.com/anthropics/claude-code-action/blob/main/docs/usage.md
- # or https://code.claude.com/docs/en/cli-reference for available options
- `
|