Skip to content

Commit 0d9513b

Browse files
authored
refactor: restructure documentation into organized docs directory (anthropics#383)
- Move FAQ.md to docs/faq.md - Create structured documentation files: - setup.md: Manual setup and custom GitHub app instructions - usage.md: Basic usage and workflow configuration - custom-automations.md: Automation examples - configuration.md: MCP servers and advanced settings - experimental.md: Execution modes and network restrictions - cloud-providers.md: AWS Bedrock and Google Vertex setup - capabilities-and-limitations.md: Features and constraints - security.md: Security information - Condense README.md to overview with links to detailed docs - Keep CONTRIBUTING.md, SECURITY.md, CODE_OF_CONDUCT.md at top level
1 parent 458e4b9 commit 0d9513b

File tree

10 files changed

+939
-965
lines changed

10 files changed

+939
-965
lines changed

README.md

Lines changed: 12 additions & 965 deletions
Large diffs are not rendered by default.
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Capabilities and Limitations
2+
3+
## What Claude Can Do
4+
5+
- **Respond in a Single Comment**: Claude operates by updating a single initial comment with progress and results
6+
- **Answer Questions**: Analyze code and provide explanations
7+
- **Implement Code Changes**: Make simple to moderate code changes based on requests
8+
- **Prepare Pull Requests**: Creates commits on a branch and links back to a prefilled PR creation page
9+
- **Perform Code Reviews**: Analyze PR changes and provide detailed feedback
10+
- **Smart Branch Handling**:
11+
- When triggered on an **issue**: Always creates a new branch for the work
12+
- When triggered on an **open PR**: Always pushes directly to the existing PR branch
13+
- When triggered on a **closed PR**: Creates a new branch since the original is no longer active
14+
- **View GitHub Actions Results**: Can access workflow runs, job logs, and test results on the PR where it's tagged when `actions: read` permission is configured (see [Additional Permissions for CI/CD Integration](./configuration.md#additional-permissions-for-cicd-integration))
15+
16+
## What Claude Cannot Do
17+
18+
- **Submit PR Reviews**: Claude cannot submit formal GitHub PR reviews
19+
- **Approve PRs**: For security reasons, Claude cannot approve pull requests
20+
- **Post Multiple Comments**: Claude only acts by updating its initial comment
21+
- **Execute Commands Outside Its Context**: Claude only has access to the repository and PR/issue context it's triggered in
22+
- **Run Arbitrary Bash Commands**: By default, Claude cannot execute Bash commands unless explicitly allowed using the `allowed_tools` configuration
23+
- **Perform Branch Operations**: Cannot merge branches, rebase, or perform other git operations beyond pushing commits
24+
25+
## How It Works
26+
27+
1. **Trigger Detection**: Listens for comments containing the trigger phrase (default: `@claude`) or issue assignment to a specific user
28+
2. **Context Gathering**: Analyzes the PR/issue, comments, code changes
29+
3. **Smart Responses**: Either answers questions or implements changes
30+
4. **Branch Management**: Creates new PRs for human authors, pushes directly for Claude's own PRs
31+
5. **Communication**: Posts updates at every step to keep you informed
32+
33+
This action is built on top of [`anthropics/claude-code-base-action`](https://github.com/anthropics/claude-code-base-action).

docs/cloud-providers.md

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
# Cloud Providers
2+
3+
You can authenticate with Claude using any of these three methods:
4+
5+
1. Direct Anthropic API (default)
6+
2. Amazon Bedrock with OIDC authentication
7+
3. Google Vertex AI with OIDC authentication
8+
9+
For detailed setup instructions for AWS Bedrock and Google Vertex AI, see the [official documentation](https://docs.anthropic.com/en/docs/claude-code/github-actions#using-with-aws-bedrock-%26-google-vertex-ai).
10+
11+
**Note**:
12+
13+
- Bedrock and Vertex use OIDC authentication exclusively
14+
- AWS Bedrock automatically uses cross-region inference profiles for certain models
15+
- For cross-region inference profile models, you need to request and be granted access to the Claude models in all regions that the inference profile uses
16+
17+
## Model Configuration
18+
19+
Use provider-specific model names based on your chosen provider:
20+
21+
```yaml
22+
# For direct Anthropic API (default)
23+
- uses: anthropics/claude-code-action@beta
24+
with:
25+
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
26+
# ... other inputs
27+
28+
# For Amazon Bedrock with OIDC
29+
- uses: anthropics/claude-code-action@beta
30+
with:
31+
model: "anthropic.claude-3-7-sonnet-20250219-beta:0" # Cross-region inference
32+
use_bedrock: "true"
33+
# ... other inputs
34+
35+
# For Google Vertex AI with OIDC
36+
- uses: anthropics/claude-code-action@beta
37+
with:
38+
model: "claude-3-7-sonnet@20250219"
39+
use_vertex: "true"
40+
# ... other inputs
41+
```
42+
43+
## OIDC Authentication for Bedrock and Vertex
44+
45+
Both AWS Bedrock and GCP Vertex AI require OIDC authentication.
46+
47+
```yaml
48+
# For AWS Bedrock with OIDC
49+
- name: Configure AWS Credentials (OIDC)
50+
uses: aws-actions/configure-aws-credentials@v4
51+
with:
52+
role-to-assume: ${{ secrets.AWS_ROLE_TO_ASSUME }}
53+
aws-region: us-west-2
54+
55+
- name: Generate GitHub App token
56+
id: app-token
57+
uses: actions/create-github-app-token@v2
58+
with:
59+
app-id: ${{ secrets.APP_ID }}
60+
private-key: ${{ secrets.APP_PRIVATE_KEY }}
61+
62+
- uses: anthropics/claude-code-action@beta
63+
with:
64+
model: "anthropic.claude-3-7-sonnet-20250219-beta:0"
65+
use_bedrock: "true"
66+
# ... other inputs
67+
68+
permissions:
69+
id-token: write # Required for OIDC
70+
```
71+
72+
```yaml
73+
# For GCP Vertex AI with OIDC
74+
- name: Authenticate to Google Cloud
75+
uses: google-github-actions/auth@v2
76+
with:
77+
workload_identity_provider: ${{ secrets.GCP_WORKLOAD_IDENTITY_PROVIDER }}
78+
service_account: ${{ secrets.GCP_SERVICE_ACCOUNT }}
79+
80+
- name: Generate GitHub App token
81+
id: app-token
82+
uses: actions/create-github-app-token@v2
83+
with:
84+
app-id: ${{ secrets.APP_ID }}
85+
private-key: ${{ secrets.APP_PRIVATE_KEY }}
86+
87+
- uses: anthropics/claude-code-action@beta
88+
with:
89+
model: "claude-3-7-sonnet@20250219"
90+
use_vertex: "true"
91+
# ... other inputs
92+
93+
permissions:
94+
id-token: write # Required for OIDC
95+
```

0 commit comments

Comments
 (0)