Chore/pysdk 000 claude doc review #13
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: "+ Claude Code / Documentation Review" | |
| on: | |
| pull_request: | |
| types: [opened, synchronize, reopened] | |
| permissions: | |
| contents: read | |
| pull-requests: write | |
| jobs: | |
| documentation-review: | |
| name: Review requirements impact | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Analyze requirements impact | |
| uses: anthropics/claude-code-action@v1 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }} | |
| prompt: | | |
| **IMPORTANT: Your ONLY job is to analyze documentation impact in requirements/ and specifications/ directories. Do NOT review code quality, do NOT comment on implementation details.** | |
| **Task:** | |
| 1. Run: git diff origin/${{ github.base_ref }}...HEAD | |
| 2. Identify which modules changed (e.g., application, wsi, platform) | |
| 3. Use Glob to find docs for those modules: | |
| - requirements/SHR-{MODULE}*.md | |
| - requirements/SWR-{MODULE}*.md | |
| - specifications/SPEC-{MODULE}*.md | |
| 4. Read those docs and check if they describe the changed functionality | |
| 5. Report ONLY documentation changes needed | |
| **RULES:** | |
| - DO NOT comment on code quality or bugs | |
| - DO NOT review implementation | |
| - ONLY report which .md files in requirements/ or specifications/ need updates | |
| - Skip files with "TEMPLATE" in name | |
| - If new docs are needed, specify the filename following existing naming patterns | |
| **Post this exact format:** | |
| ## 📋 Requirements & Specifications Impact | |
| **Changed modules:** [comma-separated list] | |
| ### 📝 Existing Docs to Update | |
| - **requirements/SHR-APPLICATION-X.md**: [1 sentence why - cite specific code change] | |
| - **specifications/SPEC-PLATFORM-SERVICE.md**: [1 sentence why - cite specific code change] | |
| ### ➕ New Docs Needed | |
| - **requirements/SWR-MODULE-X-Y.md**: [what requirement this should document] | |
| - **specifications/SPEC-NEWMODULE-SERVICE.md**: [what spec this should cover] | |
| ### ✅ Docs Already Accurate | |
| - requirements/SHR-BUCKET-1.md: Covers existing functionality, unchanged | |
| - specifications/SPEC-DATASET-SERVICE.md: Still accurate | |
| **If no doc changes needed, just say: "✅ All requirements and specifications are up to date."** | |
| Keep it SHORT - only list impacted documentation files. | |
| claude_args: >- | |
| --max-turns 30 | |
| --allowed-tools Read,Glob,Grep,Bash(git:*) | |
| --model claude-sonnet-4-5-20250929 |