textcortex/Claude Code Automatic PR Documentation Generator
Automatically generate comprehensive documentation for merged PRs using Claude Code
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| anthropic_api_key | Anthropic API key (required for direct API, not needed for Bedrock/Vertex) | no | — |
| min_lines_changed | Minimum number of lines changed to trigger documentation | no | 50 |
| min_files_changed | Minimum number of files changed to trigger documentation | no | 1 |
| documentation_prompt | Custom prompt for Claude to generate documentation | no | You are helping to automatically document a merged PR. Create comprehensive documentation for the merged PR #${{ github.event.pull_request.number }}. PR Title: ${{ github.event.pull_request.title }} PR Description: ${{ github.event.pull_request.body }} PR Author: ${{ github.event.pull_request.user.login }} Merge Date: ${{ github.event.pull_request.merged_at }} Instructions: 1. Run: git log --oneline -10 to see recent commits 2. Run: git diff ${{ github.event.pull_request.base.sha }}...${{ github.event.pull_request.head.sha }} to see what changed in PR #${{ github.event.pull_request.number }} 3. Create directory if needed: mkdir -p docs/prs 4. Create a documentation file with filename format: docs/prs/YYYY-MM-DD-appropriate-title-for-the-pr.md 5. Include this YAML front matter at the top: --- author: Claude date: YYYY-MM-DD title: [descriptive title based on PR] pr_number: ${{ github.event.pull_request.number }} pr_author: ${{ github.event.pull_request.user.login }} --- 6. Document: - Purpose and context of the changes - Key modifications made - Technical implementation details - Impact on the system - Any breaking changes or migration notes - Related issues or follow-up tasks IMPORTANT: Just create and write the documentation file. Do NOT commit or create any branches/PRs - the workflow will handle that. |
| commit_tags | Tags to append to the commit message | no | [skip ci] |
| pr_title_tags | Tags to append to the PR title | no | [skip ci] |
| documentation_directory | Directory where documentation will be created | no | docs/prs |
| timeout_minutes | Timeout for Claude to generate documentation (in minutes) | no | 10 |
| 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 }} |
| model | Model to use (provider-specific format required for Bedrock/Vertex) | no | — |
| 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 |
| allowed_tools | Additional tools for Claude to use (the base GitHub tools will always be included) | no | "" |
| disallowed_tools | Tools that Claude should never use | no | "" |
| custom_instructions | Additional custom instructions to include in the prompt for Claude | no | "" |
| pr_labels | Comma-separated list of labels to apply to the PR (labels must already exist in the repository) | no | "" |
Outputs
no outputs