Upstream Documentation Enhancer - GitHub Action

A GitHub Action that uses AI to automatically analyze code changes and update documentation using Gemini AI. Perfect for keeping documentation in sync with code changes across repositories.

🚀 Quick Start

Add this workflow file to your repository at .github/workflows/docs-enhancer.yml:

name: Auto-Update Documentation

on:
  issue_comment:
    types: [created]

permissions:
  contents: read
  issues: read
  pull-requests: read

jobs:
  update-docs:
    runs-on: ubuntu-latest
    if: |
      github.event.issue.pull_request && 
      contains(github.event.comment.body, '[update-docs]')
    steps:
      - name: Get PR information
        id: pr_info
        if: github.event.issue.pull_request
        env:
          GH_TOKEN: ${{ secrets.GH_PAT }}
        run: |
          PR_NUMBER=${{ github.event.issue.number }}
          echo "Extracting PR information for PR #$PR_NUMBER"
          PR_DATA=$(gh api repos/${{ github.repository }}/pulls/$PR_NUMBER)
          
          HEAD_REF=$(echo "$PR_DATA" | jq -r '.head.ref')
          HEAD_REPO=$(echo "$PR_DATA" | jq -r '.head.repo.full_name')
          BASE_REF=$(echo "$PR_DATA" | jq -r '.base.ref')
          
          echo "head_ref=$HEAD_REF" >> $GITHUB_OUTPUT
          echo "head_repo=$HEAD_REPO" >> $GITHUB_OUTPUT
          echo "base_ref=$BASE_REF" >> $GITHUB_OUTPUT
          echo "pr_number=$PR_NUMBER" >> $GITHUB_OUTPUT
          
          echo "PR info extracted: #$PR_NUMBER, base: $BASE_REF, head: $HEAD_REF"

      - name: Checkout PR Code
        uses: actions/checkout@v4
        with:
          repository: ${{ steps.pr_info.outputs.head_repo || github.repository }}
          ref: ${{ steps.pr_info.outputs.head_ref || github.ref }}
          fetch-depth: 0
          token: ${{ secrets.GH_PAT }}
          
      - name: Update Documentation
        uses: csoceanu/code-to-docs@v1  # Always uses latest v1.x.x
        with:
          gemini-api-key: ${{ secrets.GEMINI_API_KEY }}
          docs-repo-url: ${{ secrets.DOCS_REPO_URL }}
          github-token: ${{ secrets.GH_PAT }}
          pr-number: ${{ github.event.issue.number }}
          pr-base: origin/${{ steps.pr_info.outputs.base_ref || 'main' }}
          pr-head-sha: ${{ steps.pr_info.outputs.head_ref }}
          docs-subfolder: ${{ secrets.DOCS_SUBFOLDER }}  # Optional: for same-repo docs

Then just comment [update-docs] on any Pull Request to trigger automatic documentation updates!

🎯 How It Works

1. Triggered by PR Comments: When someone comments [update-docs] on a Pull Request
2. Analyzes Code Changes: Examines git diffs from your PRs using AI
3. Smart File Selection: Identifies relevant documentation files automatically
4. Content Generation: Generates updated documentation content in proper AsciiDoc format
5. Automated PRs: Creates pull requests in your documentation repository

⚙️ Setup (5 Minutes)

Step 1: Create Workflow File

Save the workflow above as .github/workflows/docs-enhancer.yml in your code repository.

Step 2: Add GitHub Secrets

Go to your repository Settings → Secrets and variables → Actions:

Secret Name	Description	Example
GEMINI_API_KEY	Your Gemini API key from Google AI Studio	****
DOCS_REPO_URL	URL of your documentation repository	https://github.com/org/docs
GH_PAT	GitHub Personal Access Token with repo + pull_requests:write permissions	****
DOCS_SUBFOLDER	(Optional) Relative path to docs subfolder in same repo	docs or content/docs

Step 3: That's It!

Comment [update-docs] on any PR to automatically update documentation.

---

Ready to automate your documentation? Just add the workflow file, set up secrets, and comment [update-docs] on PRs! 🚀