Update widget-doc-generator.yml

Author: harshilp24

.github/workflows/widget-doc-generator.yml

@@ -2,7 +2,7 @@ name: Widget Doc Generator
 
 on:
   schedule:
-    - cron: '0 3 * * 1' # Weekly on Monday at 03:00 UTC
+    - cron: '0 3 * * 1'  # Every Monday at 03:00 UTC
   workflow_dispatch:
     inputs:
       target_branch:
@@ -14,56 +14,63 @@ env:
   TARGET_BRANCH: ${{ github.event.inputs.target_branch || 'docs-staging' }}
 
 jobs:
-  generate_latest_widget_doc:
+  generate_widget_docs:
     runs-on: ubuntu-latest
 
     steps:
-    - name: Checkout appsmith-docs (target)
+    - name: Checkout appsmith-docs
       uses: actions/checkout@v4
       with:
         token: ${{ secrets.REPO_ACCESS_TOKEN_WIDGETS }}
         ref: ${{ env.TARGET_BRANCH }}
         fetch-depth: 0
-        persist-credentials: false
 
-    - name: Checkout appsmith repo
+    - name: Checkout appsmith (release branch)
       uses: actions/checkout@v4
       with:
         repository: appsmithorg/appsmith
         token: ${{ secrets.REPO_ACCESS_TOKEN_WIDGETS }}
         ref: release
         path: appsmith
-        fetch-depth: 10  # enough to get recent commit
+        fetch-depth: 10
 
-    - name: Get most recently committed index.tsx file
+    - name: Find last committed widget file
       id: latest-widget
       run: |
-        cd appsmith/app/client/src/widgets
-        LAST_FILE=$(git log -1 --pretty=format: --name-only | grep '/widget/index.tsx$' | head -n 1)
-        
+        cd appsmith
+
+        LAST_COMMIT=$(git log -n 1 --pretty=format:%H -- app/client/src/widgets/*/widget/index.tsx)
+
+        if [ -z "$LAST_COMMIT" ]; then
+          echo "No recent widget/index.tsx commit found. Exiting."
+          exit 0
+        fi
+
+        LAST_FILE=$(git diff-tree --no-commit-id --name-only -r $LAST_COMMIT | grep 'app/client/src/widgets/.*/widget/index.tsx' | head -n 1)
+
         if [ -z "$LAST_FILE" ]; then
-          echo "No recent widget/index.tsx found. Exiting."
+          echo "No index.tsx file found in that commit. Exiting."
           exit 0
         fi
 
-        echo "Found: $LAST_FILE"
-        echo "widget_file_path=appsmith/app/client/src/widgets/$LAST_FILE" >> $GITHUB_OUTPUT
+        echo "✅ Found: $LAST_FILE"
+        echo "widget_file_path=$LAST_FILE" >> $GITHUB_OUTPUT
         echo "changes_found=true" >> $GITHUB_ENV
 
-    - name: Generate widget doc with OpenAI
+    - name: Extract and generate documentation
       if: env.changes_found == 'true'
       run: |
         mkdir -p website/docs/widgets
-        FILE_PATH="${{ steps.latest-widget.outputs.widget_file_path }}"
-        FILE_NAME=$(basename "$FILE_PATH")
-        WIDGET_NAME=$(basename "$(dirname "$(dirname "$FILE_PATH")")")
+        WIDGET_PATH=${{ steps.latest-widget.outputs.widget_file_path }}
+        WIDGET_NAME=$(basename "$(dirname "$(dirname "$WIDGET_PATH")")")
 
-        cp "$FILE_PATH" widget_input.tsx
+        echo "📦 Processing $WIDGET_NAME from $WIDGET_PATH"
+        cp "appsmith/$WIDGET_PATH" widget_input.tsx
 
-        SYSTEM_PROMPT=$(cat .github/prompts/extract_prompt_widget.txt || echo "Extract widget info for docs.")
+        SYSTEM_PROMPT=$(cat .github/prompts/extract_prompt_widget.txt || echo "Extract important widget info.")
         USER_CONTENT=$(cat widget_input.tsx)
 
-        # Prompt 1
+        # Prompt 1: extract
         PAYLOAD1=$(jq -n \
           --arg system "$SYSTEM_PROMPT" \
           --arg user "$USER_CONTENT" \
@@ -82,14 +89,20 @@ jobs:
           -H "Content-Type: application/json" \
           -d "$PAYLOAD1")
 
-        echo "$RESPONSE1" | jq -r '.choices[0].message.content' > extracted_widget_info.md
+        if echo "$RESPONSE1" | jq -e '.error' > /dev/null; then
+          echo "❌ Error in extract step"
+          echo "$RESPONSE1" | jq .
+          exit 1
+        fi
+
+        echo "$RESPONSE1" | jq -r '.choices[0].message.content' > extracted.md
 
-        # Prompt 2
-        SYSTEM_PROMPT2=$(cat .github/prompts/generate_prompt_widget.txt || echo "Convert extracted info to markdown.")
-        EXTRACTED_CONTENT=$(cat extracted_widget_info.md)
+        # Prompt 2: generate markdown
+        SYSTEM_PROMPT=$(cat .github/prompts/generate_prompt_widget.txt || echo "Generate widget markdown documentation.")
+        EXTRACTED_CONTENT=$(cat extracted.md)
 
         PAYLOAD2=$(jq -n \
-          --arg system "$SYSTEM_PROMPT2" \
+          --arg system "$SYSTEM_PROMPT" \
           --arg user "$EXTRACTED_CONTENT" \
           '{
             model: "gpt-4-1106-preview",
@@ -106,27 +119,34 @@ jobs:
           -H "Content-Type: application/json" \
           -d "$PAYLOAD2")
 
-        echo "$RESPONSE2" | jq -r '.choices[0].message.content' > generated_widget_doc.md
-
-        cp generated_widget_doc.md "website/docs/widgets/${WIDGET_NAME}.md"
-        echo "$FILE_PATH" > scripts/processed_widgets.txt
+        if echo "$RESPONSE2" | jq -e '.error' > /dev/null; then
+          echo "❌ Error in generate step"
+          echo "$RESPONSE2" | jq .
+          exit 1
+        fi
 
+        echo "$RESPONSE2" | jq -r '.choices[0].message.content' > "website/docs/widgets/${WIDGET_NAME}.md"
+        echo "$WIDGET_PATH" > processed_widget.txt
         echo "content_generated=true" >> $GITHUB_ENV
 
-    - name: Create PR
+        rm -f widget_input.tsx extracted.md
+
+    - name: Commit and create PR
       if: env.content_generated == 'true'
       uses: peter-evans/create-pull-request@v6
       with:
         token: ${{ secrets.REPO_ACCESS_TOKEN_WIDGETS }}
-        title: "docs: auto-gen widget doc for ${{ env.TARGET_BRANCH }}"
-        commit-message: "docs: auto-generated docs for updated widget"
-        branch: "widget-doc-update/${{ github.run_id }}"
+        title: "docs: update widget docs for ${{ env.TARGET_BRANCH }}"
+        commit-message: |
+          docs: auto-generated widget documentation
+          Generated markdown for latest widget.
+        branch: "widgets-update/${{ env.TARGET_BRANCH }}-${{ github.run_id }}"
         base: ${{ env.TARGET_BRANCH }}
         add-paths: |
           website/docs/widgets/
-          scripts/processed_widgets.txt
         body: |
-          📦 Widget doc updated for latest committed widget in `release` branch.
+          🛠 Auto-generated docs for latest widget from `appsmithorg/appsmith`.
 
-          - Source: `appsmithorg/appsmith`
-          - Widget file: `$(cat scripts/processed_widgets.txt)`
+          **Branch:** `${{ env.TARGET_BRANCH }}`  
+          **Widget File:**  
+          $(cat processed_widget.txt | sed 's/^/- /')