claude-code-pr-autodoc-action

🥈Silver

A GitHub Action that automatically generates comprehensive documentation for merged pull requests using Claude Code, analyzing code changes and creating structured markdown files.

1500Updated 1mo ago

Intermediate30min to implementautomation

Saves ~45 min per use

Quick InstallView Source

git clone https://github.com/textcortex/claude-code-pr-autodoc-action.git

Works with:

Claude

Overview

About This Skill

Claude Code PR Documentation Action automatically generates comprehensive documentation for your merged pull requests by analyzing code changes with Claude Code. The GitHub Action integrates seamlessly with the Claude GitHub app and runs on your infrastructure, creating well-structured markdown files without manual effort. Configure thresholds for lines and files changed, customize documentation prompts, and automatically create pull requests with generated documentation. It supports smart filtering to document only PRs meeting your criteria, includes customizable commit and PR title tags, and works with Amazon Bedrock and Google Vertex AI. Ideal for development teams maintaining consistent documentation standards across projects.

How to Use

Install the Claude GitHub app to your repository and add your ANTHROPIC_API_KEY to repository secrets. Add the action to your workflow file with a trigger on merged pull requests. Customize inputs like min_lines_changed, documentation_directory, and custom_instructions to fit your documentation needs.

Use Cases

Automatically document code changes when pull requests merge to maintain up-to-date project documentation

Generate technical documentation for architectural decisions and implementation details in merged PRs

Create pull request documentation with customizable criteria based on lines or files changed

Maintain documentation standards across teams by filtering PRs and adding custom tags to generated docs

Setup & Installation

Quick Install

No install command available. Check the GitHub repository for manual installation instructions.

Alternative Install (Git Clone)

git clone https://github.com/textcortex/claude-code-pr-autodoc-action

Requirements

Claude Code or compatible AI agent
Works with: Claude

Quick Start Guide

Install the Skill

Copy the install command above and run it in your terminal.

Open Your AI Agent

Launch Claude Code, Cursor, or your preferred AI coding agent.

Try It Out

Use the prompt template or examples below to test the skill.

Customize

Adapt the skill to your specific use case and workflow.

Usage Examples

Prompt Template

Analyze the following merged pull request and generate comprehensive documentation. Include: [REPOSITORY_NAME], [PR_TITLE], [PR_DESCRIPTION], [CODE_CHANGES], [RELEVANT_ISSUES]. Format the output as markdown with clear headings and bullet points.

Example Output

# Pull Request Documentation

## Overview
- **Repository**: example-repo
- **Pull Request**: #42 - Update user authentication flow
- **Author**: @dev-user
- **Merged On**: 2023-11-15

## Changes Implemented
- Updated authentication middleware to support OAuth 2.0
- Added rate limiting to prevent brute force attacks
- Improved error handling for failed login attempts

## Technical Details
- **Files Modified**: 5
- **Lines Added**: 142
- **Lines Deleted**: 38

## Related Issues
- Fixed #38: Authentication bypass vulnerability
- Addressed #45: Rate limiting requirements

## Impact
- Enhanced security for user accounts
- Improved system reliability under high traffic
- Better compliance with industry standards