ci(workflows): simplify docs review workflow and fix changelog extraction

ThomasK33 · ThomasK33 · commit aa38bee0dacf · 2025-05-23T15:51:06.000+02:00
Change-Id: I5b263e9cdd9af5f126ef358c67a743eaaecff8a2
Signed-off-by: Thomas Kosiewski &lt;tk@coder.com&gt;
diff --git a/.github/workflows/claude-review.yaml b/.github/workflows/claude-review.yaml
@@ -20,7 +20,7 @@ jobs:
 
       - name: Run Code Review with Claude
         id: code-review
-        uses: anthropics/claude-code-action@8b9d5bb25a638c9aa5103496c0139d99b4936d42 # beta
+        uses: anthropics/claude-code-action@8e84799f37d42f24e0ebae41205346879bdcab5a # v0.0.7
         with:
           # Define the review focus areas
           prompt: "Review the PR changes. Focus on code quality, potential bugs, and performance issues. Suggest improvements where appropriate."
diff --git a/.github/workflows/claude.yml b/.github/workflows/claude.yml
@@ -33,6 +33,6 @@ jobs:
 
       - name: Run Claude Code
         id: claude
-        uses: anthropics/claude-code-action@8b9d5bb25a638c9aa5103496c0139d99b4936d42 # beta
+        uses: anthropics/claude-code-action@8e84799f37d42f24e0ebae41205346879bdcab5a # v0.0.7
         with:
           anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
diff --git a/.github/workflows/docs-review.yml b/.github/workflows/docs-review.yml
@@ -24,11 +24,11 @@ jobs:
 
       - name: Run Claude Code to review documentation
         id: claude-review
-        uses: anthropics/claude-code-action@8b9d5bb25a638c9aa5103496c0139d99b4936d42 # beta
+        uses: anthropics/claude-code-action@8e84799f37d42f24e0ebae41205346879bdcab5a # v0.0.7
         with:
           anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
           prompt: |
-            As a Documentation Validator, your task is to review the current code in this repository and ensure that the markdown documentation files (README.md, ARCHITECTURE.md, and DEVELOPMENT.md) are up-to-date and accurate.
+            As a Documentation Validator, review the current code in this repository and ensure that the markdown documentation files (README.md, ARCHITECTURE.md, and DEVELOPMENT.md) are up-to-date and accurate.
 
             Focus on these specific areas:
             1. Configuration options - Ensure all config options in lua/claudecode/config.lua are accurately reflected in README.md
@@ -37,155 +37,35 @@ jobs:
             4. Development status - Review the implementation status in DEVELOPMENT.md against the actual codebase
             5. Terminal feature - Check that the terminal integration is documented correctly across all files
 
-            For any inconsistencies found:
-            1. Note the specific issue (what's incorrect, missing, or outdated)
-            2. Provide the correct information based on the current codebase
-            3. Create a corrected version of the relevant section
+            If you find any inconsistencies:
+            1. Update the documentation files directly with the correct information
+            2. Make the changes minimal and focused
+            3. Ensure all changes are accurate based on the current codebase
 
-            Output your findings in this format:
-            ```json
-            {
-              "review_date": "YYYY-MM-DD",
-              "files_checked": ["README.md", "ARCHITECTURE.md", "DEVELOPMENT.md"],
-              "issues_found": [
-                {
-                  "file": "path/to/file.md",
-                  "section": "Section title",
-                  "issue": "Description of inconsistency",
-                  "corrected_content": "The corrected markdown content"
-                }
-              ]
-            }
-            ```
+            After making any necessary updates, create a git commit with the message "docs: update documentation to match current codebase" if changes were made.
 
-            If no issues are found, return an empty "issues_found" array.
-
-      - name: Process documentation updates
-        id: process-updates
-        shell: bash
-        # zizmor-disable-next-line template-injection
-        env:
-          CLAUDE_OUTPUT: ${{ steps.claude-review.outputs.result }}
-        run: |
-          # Extract issues from Claude's output
-
-          # Check if the output contains the expected JSON format
-          if ! echo "$CLAUDE_OUTPUT" | grep -q "\"issues_found\""; then
-            echo "No valid JSON output found from Claude review"
-            exit 0
-          fi
-
-          # Extract the JSON part (between ```json and ```)
-          echo "$CLAUDE_OUTPUT" | sed -n "/\`\`\`json/,/\`\`\`/p" | sed "1d;\$d" > json_output.txt
-          echo "JSON output extracted"
-
-          # Parse the JSON and check if there are issues
-          ISSUES_FOUND=$(jq ".issues_found | length" json_output.txt)
-          echo "Issues found: $ISSUES_FOUND"
-
-          # Clean up json_output.txt if no issues are found or after processing
-          if [ "$ISSUES_FOUND" -eq 0 ]; then
-            echo "No documentation issues found"
-            rm -f json_output.txt # Clean up if exiting early
-            exit 0
-          fi
-
-          if [ "$ISSUES_FOUND" -eq 0 ]; then
-            echo "No documentation issues found"
-            exit 0
-          fi
-
-          echo "Found $ISSUES_FOUND documentation issues to fix"
-          echo "issues_found=$ISSUES_FOUND" >> "$GITHUB_OUTPUT"
-
-          # Create a new branch for the fixes
-          BRANCH_NAME="docs/update-$(date +%Y%m%d%H%M%S)"
-          git checkout -b "$BRANCH_NAME"
-
-          # Apply each correction - use a safer approach
-          for i in $(seq 0 $((ISSUES_FOUND - 1))); do
-            # Extract each field safely into separate files
-            jq -r ".issues_found[$i].file" json_output.txt > issue_file.txt
-            jq -r ".issues_found[$i].section" json_output.txt > issue_section.txt
-            jq -r ".issues_found[$i].issue" json_output.txt > issue_desc.txt
-            jq -r ".issues_found[$i].corrected_content" json_output.txt > issue_content.txt
-
-            # Read from files
-            FILE=$(cat issue_file.txt)
-            SECTION=$(cat issue_section.txt)
-            ISSUE=$(cat issue_desc.txt)
-            CONTENT=$(cat issue_content.txt)
-
-            echo "Updating $FILE - Section: $SECTION"
-
-            # Escape content for sed using files for safety
-            sed -E "s/[\/&]/\\&/g" issue_content.txt > escaped_content.txt
-            ESCAPED_CONTENT=$(cat escaped_content.txt)
-
-            # Look for the section and apply the change
-            # This is a basic approach; more sophisticated section matching might be needed
-            if grep -q "$SECTION" "$FILE"; then
-              # Try to find the section and replace content from the section title until the next section
-              sed -i "/# $SECTION/,/# /c\\# $SECTION\n\n$ESCAPED_CONTENT\n\n# " "$FILE"
-            else
-              echo "Section not found: $SECTION in $FILE. Adding to the end of the file."
-              echo -e "\n# $SECTION\n\n$CONTENT" >> "$FILE"
-            fi
-          done
-
-          # Clean up temporary files used in the loop
-          rm -f issue_file.txt issue_section.txt issue_desc.txt issue_content.txt escaped_content.txt
-          # Clean up json_output.txt after it's fully processed
-          rm -f json_output.txt
-
-          # Set up git identity for Claude
-          git config --local user.email "noreply@anthropic.com"
-          git config --local user.name "Claude"
-
-          # Commit the changes
-          git add README.md ARCHITECTURE.md DEVELOPMENT.md
-          git commit -m "docs: update documentation based on code analysis"
-          git push origin "$BRANCH_NAME"
-
-          echo "branch_name=$BRANCH_NAME" >> "$GITHUB_OUTPUT"
-
-          # Create summary of changes to display in PR
-          CHANGES_SUMMARY=""
-          for i in $(seq 0 $((ISSUES_FOUND - 1))); do
-            FILE=$(echo "$JSON_OUTPUT" | jq -r ".issues_found[$i].file")
-            SECTION=$(echo "$JSON_OUTPUT" | jq -r ".issues_found[$i].section")
-            ISSUE=$(echo "$JSON_OUTPUT" | jq -r ".issues_found[$i].issue")
-
-            CHANGES_SUMMARY="${CHANGES_SUMMARY}- **${FILE}** (${SECTION}): ${ISSUE}\n"
-          done
-
-          {
-            echo "changes_summary<<EOF"
-            echo -e "$CHANGES_SUMMARY"
-            echo "EOF"
-          } >> "$GITHUB_OUTPUT"
-
-      - name: Create Pull Request
-        if: steps.process-updates.outputs.issues_found > 0
-        uses: anthropics/claude-pr-action@8b9d5bb25a638c9aa5103496c0139d99b4936d42 # v1
+      - name: Create Pull Request if changes were made
+        uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e # v7.0.8
         with:
-          anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          branch: ${{ steps.process-updates.outputs.branch_name }}
-          base: main
+          token: ${{ secrets.GITHUB_TOKEN }}
+          commit-message: "docs: update documentation to match current codebase"
           title: "docs: Update documentation to match current codebase"
           body: |
             This PR was automatically generated by Claude Code to update documentation files based on code analysis.
 
             ## What's Changed
 
-            Documentation has been updated to match the current codebase. The following issues were addressed:
-
-            ${{ steps.process-updates.outputs.changes_summary }}
+            Documentation has been updated to match the current codebase state:
+            - Configuration options synchronized with actual code
+            - Commands and usage examples verified
+            - Architecture details updated to reflect current structure
+            - Development status aligned with implementation
 
-            The following files were updated:
+            ## Files Updated
             - README.md
             - ARCHITECTURE.md
             - DEVELOPMENT.md
 
             Please review these changes to ensure they accurately reflect the current state of the project.
+          branch: docs/auto-update
+          delete-branch: true
diff --git a/.github/workflows/update-changelog.yml b/.github/workflows/update-changelog.yml
@@ -23,7 +23,8 @@ jobs:
         shell: bash
         # zizmor-disable-next-line template-injection
         run: |
-          COMMIT_MSG=$(git log -1 --pretty=%B)
+          # Get only the first line of commit message (subject line)
+          COMMIT_MSG=$(git log -1 --pretty=%s)
           {
             echo "commit_msg=${COMMIT_MSG}"
             echo "commit_type=$(echo "${COMMIT_MSG}" | grep -o '^feat\|^fix\|^docs\|^style\|^refactor\|^perf\|^test\|^build\|^ci\|^chore' || echo 'other')"
