DocuPilot Action

AI-powered documentation generator for GitHub repos. Automatically update your README, CHANGELOG, and API docs on every push.

Try It in 30 Seconds

Fork the docupilot-demo template, add your ANTHROPIC_API_KEY secret, and push a change to see it work.

Quick Start

# .github/workflows/docupilot.yml
name: DocuPilot
on:
  push:
    branches: [main]

permissions:
  contents: write
  pull-requests: write

jobs:
  docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: AkrMcmr/docupilot-action@v1
        with:
          anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}

That's it. Push code, get a PR with updated docs.

What It Does

1. Analyzes your source code and recent commits
2. Uses Claude AI to generate/update documentation
3. Creates a Pull Request with the changes

You stay in control — review, edit, and merge like any other PR.

Inputs

Input	Required	Default	Description
anthropic_api_key	Yes	—	Your Anthropic API key
github_token	No	${{ github.token }}	GitHub token for creating PRs
generate_readme	No	true	Generate/update README.md
generate_changelog	No	true	Generate/update CHANGELOG.md
language	No	en	Documentation language (en, ja, zh, es, etc.)
model	No	claude-sonnet-4-6	Claude model to use

Outputs

Output	Description
pr_url	URL of the created pull request
pr_number	Number of the created pull request

Examples

Only README updates

- uses: AkrMcmr/docupilot-action@v1
  with:
    anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
    generate_changelog: 'false'

Japanese documentation

- uses: AkrMcmr/docupilot-action@v1
  with:
    anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
    language: 'ja'

Run only on specific paths

on:
  push:
    branches: [main]
    paths:
      - 'src/**'
      - 'lib/**'

Live Demo

DocuPilot dogfoods itself — see real PRs generated by this action:

• docupilot-action#1 — DocuPilot documenting its own codebase
• docupilot#2 — DocuPilot documenting the SaaS version

Zero-Config Alternative

Don't want to manage API keys? Try the DocuPilot SaaS — install the GitHub App and get automatic documentation updates with zero configuration.

• Free: 1 repo
• Starter: $9/mo — 5 repos
• Pro: $29/mo — unlimited repos + API docs

License

MIT