CLAUDE.md

1# CLAUDE.md
2 
3## Common Commands
4 
5### Development Commands
6 
7- Build/Type check: `bun run typecheck`
8- Format code: `bun run format`
9- Check formatting: `bun run format:check`
10- Run tests: `bun test`
11- Install dependencies: `bun install`
12 
13### Action Testing
14 
15- Test action locally: `./test-local.sh`
16- Test specific file: `bun test test/prepare-prompt.test.ts`
17 
18## Architecture Overview
19 
20This is a GitHub Action that allows running Claude Code within GitHub workflows. The action consists of:
21 
22### Core Components
23 
241. **Action Definition** (`action.yml`): Defines inputs, outputs, and the composite action steps
252. **Prompt Preparation** (`src/index.ts`): Runs Claude Code with specified arguments
26 
27### Key Design Patterns
28 
29- Uses Bun runtime for development and execution
30- JSON streaming output format for execution logs
31- Composite action pattern to orchestrate multiple steps
32- Provider-agnostic design supporting Anthropic API, AWS Bedrock, and Google Vertex AI
33 
34## Provider Authentication
35 
361. **Anthropic API** (default): Requires API key via `anthropic_api_key` input
372. **AWS Bedrock**: Uses OIDC authentication when `use_bedrock: true`
383. **Google Vertex AI**: Uses OIDC authentication when `use_vertex: true`
39 
40## Testing Strategy
41 
42### Local Testing
43 
44- Use `act` tool to run GitHub Actions workflows locally
45- `test-local.sh` script automates local testing setup
46- Requires `ANTHROPIC_API_KEY` environment variable
47 
48### Test Structure
49 
50- Unit tests for configuration logic
51- Integration tests for prompt preparation
52- Full workflow tests in `.github/workflows/test-base-action.yml`
53 
54## Important Technical Details
55 
56- Outputs execution logs as JSON to `/tmp/claude-execution-output.json`
57- Timeout enforcement via `timeout` command wrapper
58- Strict TypeScript configuration with Bun-specific settings
59