anthropics/claude-code-action
1
0
Fork 0
mirror of https://github.com/anthropics/claude-code-action.git synced 2026-01-22 22:44:13 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: update base-action README examples from @beta to @v1

Browse Source 
Co-authored-by: JB <hackyon-anthropic@users.noreply.github.com>
This commit is contained in:
claude[bot]
2026-01-14 15:09:59 +00:00
parent 5875a49630
commit a9bd2f53bf
1 changed files with 21 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
base-action/README.md
View File

@@ -11,7 +11,7 @@ Add the following to your workflow file:
```yaml ```yaml
# Using a direct prompt # Using a direct prompt
- name: Run Claude Code with direct prompt - name: Run Claude Code with direct prompt
uses: anthropics/claude-code-base-action@beta uses: anthropics/claude-code-base-action@v1
with: with:
prompt: "Your prompt here" prompt: "Your prompt here"
allowed_tools: "Bash(git:*),View,GlobTool,GrepTool,BatchTool" allowed_tools: "Bash(git:*),View,GlobTool,GrepTool,BatchTool"
@@ -19,7 +19,7 @@ Add the following to your workflow file:
# Or using a prompt from a file # Or using a prompt from a file
- name: Run Claude Code with prompt file - name: Run Claude Code with prompt file
uses: anthropics/claude-code-base-action@beta uses: anthropics/claude-code-base-action@v1
with: with:
prompt_file: "/path/to/prompt.txt" prompt_file: "/path/to/prompt.txt"
allowed_tools: "Bash(git:*),View,GlobTool,GrepTool,BatchTool" allowed_tools: "Bash(git:*),View,GlobTool,GrepTool,BatchTool"
@@ -27,7 +27,7 @@ Add the following to your workflow file:
# Or limiting the conversation turns # Or limiting the conversation turns
- name: Run Claude Code with limited turns - name: Run Claude Code with limited turns
uses: anthropics/claude-code-base-action@beta uses: anthropics/claude-code-base-action@v1
with: with:
prompt: "Your prompt here" prompt: "Your prompt here"
allowed_tools: "Bash(git:*),View,GlobTool,GrepTool,BatchTool" allowed_tools: "Bash(git:*),View,GlobTool,GrepTool,BatchTool"
@@ -36,7 +36,7 @@ Add the following to your workflow file:
# Using custom system prompts # Using custom system prompts
- name: Run Claude Code with custom system prompt - name: Run Claude Code with custom system prompt
uses: anthropics/claude-code-base-action@beta uses: anthropics/claude-code-base-action@v1
with: with:
prompt: "Build a REST API" prompt: "Build a REST API"
system_prompt: "You are a senior backend engineer. Focus on security, performance, and maintainability." system_prompt: "You are a senior backend engineer. Focus on security, performance, and maintainability."
@@ -45,7 +45,7 @@ Add the following to your workflow file:
# Or appending to the default system prompt # Or appending to the default system prompt
- name: Run Claude Code with appended system prompt - name: Run Claude Code with appended system prompt
uses: anthropics/claude-code-base-action@beta uses: anthropics/claude-code-base-action@v1
with: with:
prompt: "Create a database schema" prompt: "Create a database schema"
append_system_prompt: "After writing code, be sure to code review yourself." append_system_prompt: "After writing code, be sure to code review yourself."
@@ -54,7 +54,7 @@ Add the following to your workflow file:
# Using custom environment variables # Using custom environment variables
- name: Run Claude Code with custom environment variables - name: Run Claude Code with custom environment variables
uses: anthropics/claude-code-base-action@beta uses: anthropics/claude-code-base-action@v1
with: with:
prompt: "Deploy to staging environment" prompt: "Deploy to staging environment"
claude_env: | claude_env: |
@@ -66,7 +66,7 @@ Add the following to your workflow file:
# Using fallback model for handling API errors # Using fallback model for handling API errors
- name: Run Claude Code with fallback model - name: Run Claude Code with fallback model
uses: anthropics/claude-code-base-action@beta uses: anthropics/claude-code-base-action@v1
with: with:
prompt: "Review and fix TypeScript errors" prompt: "Review and fix TypeScript errors"
model: "claude-opus-4-1-20250805" model: "claude-opus-4-1-20250805"
@@ -76,7 +76,7 @@ Add the following to your workflow file:
# Using OAuth token instead of API key # Using OAuth token instead of API key
- name: Run Claude Code with OAuth token - name: Run Claude Code with OAuth token
uses: anthropics/claude-code-base-action@beta uses: anthropics/claude-code-base-action@v1
with: with:
prompt: "Update dependencies" prompt: "Update dependencies"
allowed_tools: "Bash(git:*),View,GlobTool,GrepTool,BatchTool" allowed_tools: "Bash(git:*),View,GlobTool,GrepTool,BatchTool"
@@ -130,7 +130,7 @@ Example usage:
```yaml ```yaml
- name: Run Claude Code with Node.js 20 - name: Run Claude Code with Node.js 20
uses: anthropics/claude-code-base-action@beta uses: anthropics/claude-code-base-action@v1
env: env:
NODE_VERSION: "20.x" NODE_VERSION: "20.x"
with: with:
@@ -146,7 +146,7 @@ The `claude_env` input accepts YAML multiline format with key-value pairs:
```yaml ```yaml
- name: Deploy with custom environment - name: Deploy with custom environment
uses: anthropics/claude-code-base-action@beta uses: anthropics/claude-code-base-action@v1
with: with:
prompt: "Deploy the application to the staging environment" prompt: "Deploy the application to the staging environment"
claude_env: | claude_env: |
@@ -200,7 +200,7 @@ Provide a path to a JSON file containing Claude Code settings:
```yaml ```yaml
- name: Run Claude Code with settings file - name: Run Claude Code with settings file
uses: anthropics/claude-code-base-action@beta uses: anthropics/claude-code-base-action@v1
with: with:
prompt: "Your prompt here" prompt: "Your prompt here"
settings: "path/to/settings.json" settings: "path/to/settings.json"
@@ -214,7 +214,7 @@ Provide the settings configuration directly as a JSON string:
```yaml ```yaml
- name: Run Claude Code with inline settings - name: Run Claude Code with inline settings
uses: anthropics/claude-code-base-action@beta uses: anthropics/claude-code-base-action@v1
with: with:
prompt: "Your prompt here" prompt: "Your prompt here"
settings: | settings: |
@@ -263,7 +263,7 @@ Provide a path to a JSON file containing MCP configuration:
```yaml ```yaml
- name: Run Claude Code with MCP config file - name: Run Claude Code with MCP config file
uses: anthropics/claude-code-base-action@beta uses: anthropics/claude-code-base-action@v1
with: with:
prompt: "Your prompt here" prompt: "Your prompt here"
mcp_config: "path/to/mcp-config.json" mcp_config: "path/to/mcp-config.json"
@@ -277,7 +277,7 @@ Provide the MCP configuration directly as a JSON string:
```yaml ```yaml
- name: Run Claude Code with inline MCP config - name: Run Claude Code with inline MCP config
uses: anthropics/claude-code-base-action@beta uses: anthropics/claude-code-base-action@v1
with: with:
prompt: "Your prompt here" prompt: "Your prompt here"
mcp_config: | mcp_config: |
@@ -317,7 +317,7 @@ You can combine MCP config with other inputs like allowed tools:
```yaml ```yaml
# Using multiple inputs together # Using multiple inputs together
- name: Run Claude Code with MCP and custom tools - name: Run Claude Code with MCP and custom tools
uses: anthropics/claude-code-base-action@beta uses: anthropics/claude-code-base-action@v1
with: with:
prompt: "Access the custom MCP server and use its tools" prompt: "Access the custom MCP server and use its tools"
mcp_config: "mcp-config.json" mcp_config: "mcp-config.json"
@@ -345,7 +345,7 @@ jobs:
- name: Run Code Review with Claude - name: Run Code Review with Claude
id: code-review id: code-review
uses: anthropics/claude-code-base-action@beta uses: anthropics/claude-code-base-action@v1
with: with:
prompt: "Review the PR changes. Focus on code quality, potential bugs, and performance issues. Suggest improvements where appropriate. Write your review as markdown text." prompt: "Review the PR changes. Focus on code quality, potential bugs, and performance issues. Suggest improvements where appropriate. Write your review as markdown text."
allowed_tools: "Bash(git diff --name-only HEAD~1),Bash(git diff HEAD~1),View,GlobTool,GrepTool,Write" allowed_tools: "Bash(git diff --name-only HEAD~1),Bash(git diff HEAD~1),View,GlobTool,GrepTool,Write"
@@ -408,7 +408,7 @@ Use provider-specific model names based on your chosen provider:
```yaml ```yaml
# For direct Anthropic API (default) # For direct Anthropic API (default)
- name: Run Claude Code with Anthropic API - name: Run Claude Code with Anthropic API
uses: anthropics/claude-code-base-action@beta uses: anthropics/claude-code-base-action@v1
with: with:
prompt: "Your prompt here" prompt: "Your prompt here"
model: "claude-3-7-sonnet-20250219" model: "claude-3-7-sonnet-20250219"
@@ -422,7 +422,7 @@ Use provider-specific model names based on your chosen provider:
aws-region: us-west-2 aws-region: us-west-2
- name: Run Claude Code with Bedrock - name: Run Claude Code with Bedrock
uses: anthropics/claude-code-base-action@beta uses: anthropics/claude-code-base-action@v1
with: with:
prompt: "Your prompt here" prompt: "Your prompt here"
model: "anthropic.claude-3-7-sonnet-20250219-v1:0" model: "anthropic.claude-3-7-sonnet-20250219-v1:0"
@@ -436,7 +436,7 @@ Use provider-specific model names based on your chosen provider:
service_account: ${{ secrets.GCP_SERVICE_ACCOUNT }} service_account: ${{ secrets.GCP_SERVICE_ACCOUNT }}
- name: Run Claude Code with Vertex AI - name: Run Claude Code with Vertex AI
uses: anthropics/claude-code-base-action@beta uses: anthropics/claude-code-base-action@v1
with: with:
prompt: "Your prompt here" prompt: "Your prompt here"
model: "claude-3-7-sonnet@20250219" model: "claude-3-7-sonnet@20250219"
@@ -455,7 +455,7 @@ This example shows how to use OIDC authentication with AWS Bedrock:
aws-region: us-west-2 aws-region: us-west-2
- name: Run Claude Code with AWS OIDC - name: Run Claude Code with AWS OIDC
uses: anthropics/claude-code-base-action@beta uses: anthropics/claude-code-base-action@v1
with: with:
prompt: "Your prompt here" prompt: "Your prompt here"
use_bedrock: "true" use_bedrock: "true"
@@ -475,7 +475,7 @@ This example shows how to use OIDC authentication with GCP Vertex AI:
service_account: ${{ secrets.GCP_SERVICE_ACCOUNT }} service_account: ${{ secrets.GCP_SERVICE_ACCOUNT }}
- name: Run Claude Code with GCP OIDC - name: Run Claude Code with GCP OIDC
uses: anthropics/claude-code-base-action@beta uses: anthropics/claude-code-base-action@v1
with: with:
prompt: "Your prompt here" prompt: "Your prompt here"
use_vertex: "true" use_vertex: "true"