Create Github Actions to automate docs updates with Mintlify Agent #484
Conversation
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
🟡 Heimdall Review Status
|
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Comment on lines
+25
to
+388
| runs-on: ubuntu-latest | ||
| if: github.event.pull_request.draft == false || github.event_name == 'workflow_dispatch' | ||
|
|
||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| fetch-depth: 0 | ||
| token: ${{ secrets.GITHUB_TOKEN }} | ||
|
|
||
| - name: Setup Node.js | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: '18' | ||
|
|
||
| - name: Get PR information | ||
| id: pr-info | ||
| run: | | ||
| if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then | ||
| # Get PR info from API for manual trigger | ||
| PR_NUMBER="${{ github.event.inputs.pr_number }}" | ||
| PR_DATA=$(curl -s -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \ | ||
| "https://api.github.com/repos/${{ github.repository }}/pulls/${PR_NUMBER}") | ||
|
|
||
| echo "pr_number=${PR_NUMBER}" >> $GITHUB_OUTPUT | ||
| echo "pr_title=$(echo "$PR_DATA" | jq -r '.title')" >> $GITHUB_OUTPUT | ||
| echo "pr_body=$(echo "$PR_DATA" | jq -r '.body // ""')" >> $GITHUB_OUTPUT | ||
| echo "pr_url=$(echo "$PR_DATA" | jq -r '.html_url')" >> $GITHUB_OUTPUT | ||
| echo "head_sha=$(echo "$PR_DATA" | jq -r '.head.sha')" >> $GITHUB_OUTPUT | ||
| echo "base_sha=$(echo "$PR_DATA" | jq -r '.base.sha')" >> $GITHUB_OUTPUT | ||
| else | ||
| # Use event data for automatic trigger | ||
| echo "pr_number=${{ github.event.number }}" >> $GITHUB_OUTPUT | ||
| echo "pr_title=${{ github.event.pull_request.title }}" >> $GITHUB_OUTPUT | ||
| echo "pr_body=${{ github.event.pull_request.body }}" >> $GITHUB_OUTPUT | ||
| echo "pr_url=${{ github.event.pull_request.html_url }}" >> $GITHUB_OUTPUT | ||
| echo "head_sha=${{ github.event.pull_request.head.sha }}" >> $GITHUB_OUTPUT | ||
| echo "base_sha=${{ github.event.pull_request.base.sha }}" >> $GITHUB_OUTPUT | ||
| fi | ||
|
|
||
| - name: Get changed files | ||
| id: changed-files | ||
| run: | | ||
| # Get the diff between base and head | ||
| git diff --name-only ${{ steps.pr-info.outputs.base_sha }}..${{ steps.pr-info.outputs.head_sha }} > changed_files.txt | ||
|
|
||
| # Filter for documentation files | ||
| grep -E '\.(mdx?|txt)$' changed_files.txt | grep '^docs/' > doc_files.txt || true | ||
|
|
||
| if [ -s doc_files.txt ]; then | ||
| CHANGED_FILES=$(cat doc_files.txt | tr '\n' ' ') | ||
| echo "changed_files=${CHANGED_FILES}" >> $GITHUB_OUTPUT | ||
| echo "has_doc_changes=true" >> $GITHUB_OUTPUT | ||
| echo "Changed documentation files: ${CHANGED_FILES}" | ||
| else | ||
| echo "has_doc_changes=false" >> $GITHUB_OUTPUT | ||
| echo "No documentation files changed" | ||
| fi | ||
|
|
||
| - name: Analyze documentation structure | ||
| id: analyze | ||
| if: steps.changed-files.outputs.has_doc_changes == 'true' | ||
| run: | | ||
| # Create a comprehensive analysis of the changes | ||
| cat > analyze_changes.js << 'EOF' | ||
| const fs = require('fs'); | ||
| const path = require('path'); | ||
|
|
||
| const changedFiles = process.env.CHANGED_FILES.split(' ').filter(f => f.trim()); | ||
| const analysis = { | ||
| sections: new Set(), | ||
| fileTypes: new Set(), | ||
| hasLlmsChanges: false, | ||
| hasConfigChanges: false, | ||
| affectedFeatures: new Set() | ||
| }; | ||
|
|
||
| changedFiles.forEach(file => { | ||
| // Determine section | ||
| const parts = file.split('/'); | ||
| if (parts.length > 1) { | ||
| analysis.sections.add(parts[1]); // docs/section-name/... | ||
| } | ||
|
|
||
| // Determine file type | ||
| const ext = path.extname(file); | ||
| analysis.fileTypes.add(ext); | ||
|
|
||
| // Check for special files | ||
| if (file.includes('llms')) { | ||
| analysis.hasLlmsChanges = true; | ||
| } | ||
| if (file.includes('docs.json')) { | ||
| analysis.hasConfigChanges = true; | ||
| } | ||
|
|
||
| // Detect features from file paths | ||
| if (file.includes('quickstart')) analysis.affectedFeatures.add('quickstart'); | ||
| if (file.includes('guide')) analysis.affectedFeatures.add('guides'); | ||
| if (file.includes('reference')) analysis.affectedFeatures.add('api-reference'); | ||
| if (file.includes('tutorial')) analysis.affectedFeatures.add('tutorials'); | ||
| }); | ||
|
|
||
| console.log('SECTIONS=' + Array.from(analysis.sections).join(',')); | ||
| console.log('FILE_TYPES=' + Array.from(analysis.fileTypes).join(',')); | ||
| console.log('HAS_LLMS_CHANGES=' + analysis.hasLlmsChanges); | ||
| console.log('HAS_CONFIG_CHANGES=' + analysis.hasConfigChanges); | ||
| console.log('AFFECTED_FEATURES=' + Array.from(analysis.affectedFeatures).join(',')); | ||
| EOF | ||
|
|
||
| CHANGED_FILES="${{ steps.changed-files.outputs.changed_files }}" node analyze_changes.js > analysis_output.txt | ||
|
|
||
| # Parse the output | ||
| while IFS= read -r line; do | ||
| if [[ $line == SECTIONS=* ]]; then | ||
| echo "sections=${line#SECTIONS=}" >> $GITHUB_OUTPUT | ||
| elif [[ $line == FILE_TYPES=* ]]; then | ||
| echo "file_types=${line#FILE_TYPES=}" >> $GITHUB_OUTPUT | ||
| elif [[ $line == HAS_LLMS_CHANGES=* ]]; then | ||
| echo "has_llms_changes=${line#HAS_LLMS_CHANGES=}" >> $GITHUB_OUTPUT | ||
| elif [[ $line == HAS_CONFIG_CHANGES=* ]]; then | ||
| echo "has_config_changes=${line#HAS_CONFIG_CHANGES=}" >> $GITHUB_OUTPUT | ||
| elif [[ $line == AFFECTED_FEATURES=* ]]; then | ||
| echo "affected_features=${line#AFFECTED_FEATURES=}" >> $GITHUB_OUTPUT | ||
| fi | ||
| done < analysis_output.txt | ||
|
|
||
| - name: Generate context-aware prompt | ||
| id: prompt | ||
| if: steps.changed-files.outputs.has_doc_changes == 'true' | ||
| run: | | ||
| # Create a context-aware prompt based on the analysis | ||
| SECTIONS="${{ steps.analyze.outputs.sections }}" | ||
| FEATURES="${{ steps.analyze.outputs.affected_features }}" | ||
| HAS_LLMS="${{ steps.analyze.outputs.has_llms_changes }}" | ||
| HAS_CONFIG="${{ steps.analyze.outputs.has_config_changes }}" | ||
| CUSTOM_PROMPT="${{ github.event.inputs.custom_prompt }}" | ||
|
|
||
| PROMPT="Review and improve the documentation changes in PR #${{ steps.pr-info.outputs.pr_number }}: ${{ steps.pr-info.outputs.pr_url }} | ||
|
|
||
| **PR Title:** ${{ steps.pr-info.outputs.pr_title }} | ||
|
|
||
| **PR Description:** ${{ steps.pr-info.outputs.pr_body }} | ||
|
|
||
| **Changed Files:** ${{ steps.changed-files.outputs.changed_files }} | ||
|
|
||
| **Analysis:** | ||
| - Affected sections: ${SECTIONS} | ||
| - Affected features: ${FEATURES} | ||
| - LLMs files changed: ${HAS_LLMS} | ||
| - Configuration changed: ${HAS_CONFIG} | ||
|
|
||
| **Review Focus:**" | ||
|
|
||
| if [[ "$HAS_LLMS" == "true" ]]; then | ||
| PROMPT="$PROMPT | ||
| - ⚠️ CRITICAL: llms.txt files were modified - ensure they maintain proper structure and accurate links" | ||
| fi | ||
|
|
||
| if [[ "$HAS_CONFIG" == "true" ]]; then | ||
| PROMPT="$PROMPT | ||
| - ⚠️ CRITICAL: docs.json configuration changed - validate navigation structure and metadata" | ||
| fi | ||
|
|
||
| PROMPT="$PROMPT | ||
| - Verify technical accuracy and completeness of all changes | ||
| - Ensure consistency with Base documentation style and tone | ||
| - Validate all code examples are correct and runnable | ||
| - Check that all internal links and cross-references work | ||
| - Fix any typos, grammar issues, or formatting problems | ||
| - Ensure proper heading hierarchy and structure | ||
| - Validate that new content follows established patterns | ||
| - Update related sections if necessary for consistency" | ||
|
|
||
| if [[ -n "$CUSTOM_PROMPT" ]]; then | ||
| PROMPT="$PROMPT | ||
|
|
||
| **Additional Instructions:** $CUSTOM_PROMPT" | ||
| fi | ||
|
|
||
| # Save prompt to file for the API call | ||
| echo "$PROMPT" > agent_prompt.txt | ||
| echo "Generated context-aware prompt for Mintlify Agent" | ||
|
|
||
| - name: Create agent branch | ||
| id: branch | ||
| if: steps.changed-files.outputs.has_doc_changes == 'true' | ||
| run: | | ||
| timestamp=$(date +%s) | ||
| branch_name="mintlify-agent-pr-${{ steps.pr-info.outputs.pr_number }}-${timestamp}" | ||
| echo "branch_name=${branch_name}" >> $GITHUB_OUTPUT | ||
|
|
||
| - name: Call Mintlify Agent API | ||
| id: agent-call | ||
| if: steps.changed-files.outputs.has_doc_changes == 'true' | ||
| run: | | ||
| # Read the generated prompt | ||
| PROMPT_CONTENT=$(cat agent_prompt.txt) | ||
|
|
||
| # Create JSON payload with proper escaping | ||
| cat > payload.json << EOF | ||
| { | ||
| "branch": "${{ steps.branch.outputs.branch_name }}", | ||
| "messages": [ | ||
| { | ||
| "role": "system", | ||
| "content": "You are an expert technical documentation reviewer specializing in Base blockchain documentation. You understand the Base ecosystem, smart contracts, DeFi, and developer tools. Focus on accuracy, clarity, consistency, and following established documentation patterns. Pay special attention to code examples, API references, and cross-links between sections." | ||
| }, | ||
| { | ||
| "role": "user", | ||
| "content": $(echo "$PROMPT_CONTENT" | jq -Rs .) | ||
| } | ||
| ] | ||
| } | ||
| EOF | ||
|
|
||
| echo "🚀 Calling Mintlify Agent API..." | ||
| echo "Project ID: ${{ secrets.MINTLIFY_PROJECT_ID }}" | ||
| echo "Branch: ${{ steps.branch.outputs.branch_name }}" | ||
|
|
||
| # Make the API call with better error handling | ||
| HTTP_RESPONSE=$(curl -X POST \ | ||
| "https://api.mintlify.com/v1/agent/${{ secrets.MINTLIFY_PROJECT_ID }}/job" \ | ||
| -H "Authorization: Bearer ${{ secrets.MINTLIFY_API_ADMIN_KEY }}" \ | ||
| -H "Content-Type: application/json" \ | ||
| -d @payload.json \ | ||
| --write-out "HTTPSTATUS:%{http_code}\nTIME_TOTAL:%{time_total}" \ | ||
| --silent \ | ||
| --show-error \ | ||
| --max-time 30) | ||
|
|
||
| # Parse response | ||
| HTTP_BODY=$(echo "$HTTP_RESPONSE" | sed -E '/^(HTTPSTATUS|TIME_TOTAL):/d') | ||
| HTTP_STATUS=$(echo "$HTTP_RESPONSE" | grep "HTTPSTATUS:" | cut -d: -f2) | ||
| TIME_TOTAL=$(echo "$HTTP_RESPONSE" | grep "TIME_TOTAL:" | cut -d: -f2) | ||
|
|
||
| echo "HTTP Status: ${HTTP_STATUS}" | ||
| echo "Response Time: ${TIME_TOTAL}s" | ||
| echo "Response Body: ${HTTP_BODY}" | ||
|
|
||
| if [ "$HTTP_STATUS" -eq 200 ]; then | ||
| echo "✅ Mintlify Agent API call successful" | ||
| echo "agent_success=true" >> $GITHUB_OUTPUT | ||
|
|
||
| # Extract session ID if present in headers or response | ||
| SESSION_ID=$(echo "$HTTP_BODY" | grep -o '"session[_-]id"[[:space:]]*:[[:space:]]*"[^"]*"' | cut -d'"' -f4 || echo "") | ||
| if [ -n "$SESSION_ID" ]; then | ||
| echo "session_id=${SESSION_ID}" >> $GITHUB_OUTPUT | ||
| fi | ||
| else | ||
| echo "❌ Mintlify Agent API call failed" | ||
| echo "Status: ${HTTP_STATUS}" | ||
| echo "Body: ${HTTP_BODY}" | ||
| echo "agent_success=false" >> $GITHUB_OUTPUT | ||
| echo "error_details=${HTTP_BODY}" >> $GITHUB_OUTPUT | ||
| fi | ||
|
|
||
| - name: Post success comment | ||
| if: steps.agent-call.outputs.agent_success == 'true' | ||
| uses: actions/github-script@v7 | ||
| with: | ||
| script: | | ||
| const branchName = '${{ steps.branch.outputs.branch_name }}'; | ||
| const sections = '${{ steps.analyze.outputs.sections }}'; | ||
| const features = '${{ steps.analyze.outputs.affected_features }}'; | ||
| const hasLlms = '${{ steps.analyze.outputs.has_llms_changes }}' === 'true'; | ||
| const hasConfig = '${{ steps.analyze.outputs.has_config_changes }}' === 'true'; | ||
|
|
||
| let specialNotes = ''; | ||
| if (hasLlms) { | ||
| specialNotes += '\n⚠️ **LLMs files changed** - The agent will pay special attention to llms.txt structure and links'; | ||
| } | ||
| if (hasConfig) { | ||
| specialNotes += '\n⚠️ **Configuration changed** - The agent will validate docs.json navigation structure'; | ||
| } | ||
|
|
||
| const comment = `## 🤖 Mintlify Agent Documentation Review Started | ||
|
|
||
| I've initiated an advanced documentation review for this PR using the Mintlify Agent. | ||
|
|
||
| **📊 Analysis:** | ||
| - **Affected sections:** ${sections || 'general'} | ||
| - **Features:** ${features || 'none detected'} | ||
| - **Review branch:** \`${branchName}\`${specialNotes} | ||
|
|
||
| **🔍 The agent will:** | ||
| - ✅ Verify technical accuracy and completeness | ||
| - ✅ Ensure Base documentation style consistency | ||
| - ✅ Validate all code examples and API references | ||
| - ✅ Check internal links and cross-references | ||
| - ✅ Fix grammar, typos, and formatting issues | ||
| - ✅ Maintain proper heading hierarchy | ||
| - ✅ Update related sections for consistency | ||
|
|
||
| **⏱️ Timeline:** The review typically takes 2-5 minutes. You'll see a new PR if improvements are suggested. | ||
|
|
||
| Monitor progress in your [Mintlify Dashboard](https://dashboard.mintlify.com) 📊 | ||
|
|
||
| --- | ||
| *Automated review triggered by documentation changes*`; | ||
|
|
||
| github.rest.issues.createComment({ | ||
| issue_number: ${{ steps.pr-info.outputs.pr_number }}, | ||
| owner: context.repo.owner, | ||
| repo: context.repo.repo, | ||
| body: comment | ||
| }); | ||
|
|
||
| - name: Post failure comment | ||
| if: steps.agent-call.outputs.agent_success == 'false' | ||
| uses: actions/github-script@v7 | ||
| with: | ||
| script: | | ||
| const errorDetails = '${{ steps.agent-call.outputs.error_details }}'; | ||
|
|
||
| const comment = `## ❌ Mintlify Agent Review Failed | ||
|
|
||
| The automated documentation review encountered an error and could not be completed. | ||
|
|
||
| **🔧 Troubleshooting Steps:** | ||
| 1. Verify Mintlify API credentials in repository secrets | ||
| 2. Check if the project ID is correct: \`MINTLIFY_PROJECT_ID\` | ||
| 3. Ensure API key has proper permissions: \`MINTLIFY_API_ADMIN_KEY\` | ||
| 4. Check for API rate limits or service issues | ||
|
|
||
| **📝 Error Details:** | ||
| \`\`\` | ||
| ${errorDetails || 'No additional error details available'} | ||
| \`\`\` | ||
|
|
||
| **🔄 Next Steps:** | ||
| - You can retry by re-running the workflow | ||
| - Or manually trigger with: \`/workflow_dispatch\` | ||
| - Consider manual review of the documentation changes | ||
|
|
||
| --- | ||
| *If this issue persists, please check the [Mintlify Status Page](https://status.mintlify.com)*`; | ||
|
|
||
| github.rest.issues.createComment({ | ||
| issue_number: ${{ steps.pr-info.outputs.pr_number }}, | ||
| owner: context.repo.owner, | ||
| repo: context.repo.repo, | ||
| body: comment | ||
| }); | ||
|
|
||
| - name: Skip comment for non-doc changes | ||
| if: steps.changed-files.outputs.has_doc_changes == 'false' | ||
| uses: actions/github-script@v7 | ||
| with: | ||
| script: | | ||
| const comment = `## 📝 Documentation Review Skipped | ||
|
|
||
| No documentation files were changed in this PR, so the Mintlify Agent review was skipped. | ||
|
|
||
| **Changed files:** Non-documentation files only | ||
|
|
||
| If you believe this is incorrect, you can manually trigger the review using the workflow dispatch option.`; | ||
|
|
||
| github.rest.issues.createComment({ | ||
| issue_number: ${{ steps.pr-info.outputs.pr_number }}, | ||
| owner: context.repo.owner, | ||
| repo: context.repo.repo, | ||
| body: comment | ||
| }); |
Check warning
Code scanning / CodeQL
Workflow does not contain permissions Medium
Show autofix suggestion
Hide autofix suggestion
Copilot Autofix
AI 9 days ago
To fix the issue, add an explicit permissions block set to the least privileges required by the workflow. In this case, the workflow uses steps that require the ability to post comments to pull requests (pull-requests: write) and read contents (contents: read), but does not need broader write permissions.
Best fix:
Add the following near the top of the workflow (either at the workflow root, after name: and before on:, or inside the job under mintlify-agent-review: but before runs-on:). The root method applies to all jobs, which is appropriate here as there is only one job.
permissions:
contents: read
pull-requests: writeWhere to make the change:
Insert these lines as line 2, pushing the existing content down (after name: and before on:).
No imports or extra config is necessary.
Suggested changeset
1
.github/workflows/mintlify-agent-advanced.yml
| @@ -1,4 +1,7 @@ | ||
| name: Advanced Mintlify Agent Documentation Review | ||
| permissions: | ||
| contents: read | ||
| pull-requests: write | ||
|
|
||
| on: | ||
| pull_request: |
Copilot is powered by AI and may make mistakes. Always verify output.
Comment on lines
+14
to
+232
| runs-on: ubuntu-latest | ||
| if: github.event.pull_request.draft == false | ||
|
|
||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| fetch-depth: 0 | ||
| token: ${{ secrets.GITHUB_TOKEN }} | ||
|
|
||
| - name: Get changed files | ||
| id: changed-files | ||
| uses: tj-actions/changed-files@v44 | ||
| with: | ||
| files: | | ||
| docs/**/*.mdx | ||
| docs/**/*.md | ||
| docs/**/llms.txt | ||
| docs/**/llms-full.txt | ||
|
|
||
| - name: Determine affected sections | ||
| id: sections | ||
| run: | | ||
| echo "Changed files: ${{ steps.changed-files.outputs.all_changed_files }}" | ||
|
|
||
| # Initialize sections array | ||
| sections=() | ||
|
|
||
| # Check each changed file and determine which section it belongs to | ||
| for file in ${{ steps.changed-files.outputs.all_changed_files }}; do | ||
| if [[ $file == docs/base-account/* ]]; then | ||
| sections+=("base-account") | ||
| elif [[ $file == docs/base-app/* ]]; then | ||
| sections+=("base-app") | ||
| elif [[ $file == docs/base-chain/* ]]; then | ||
| sections+=("base-chain") | ||
| elif [[ $file == docs/cookbook/* ]]; then | ||
| sections+=("cookbook") | ||
| elif [[ $file == docs/get-started/* ]]; then | ||
| sections+=("get-started") | ||
| elif [[ $file == docs/learn/* ]]; then | ||
| sections+=("learn") | ||
| elif [[ $file == docs/mini-apps/* ]]; then | ||
| sections+=("mini-apps") | ||
| elif [[ $file == docs/onchainkit/* ]]; then | ||
| sections+=("onchainkit") | ||
| else | ||
| sections+=("general") | ||
| fi | ||
| done | ||
|
|
||
| # Remove duplicates and create comma-separated list | ||
| unique_sections=($(printf "%s\n" "${sections[@]}" | sort -u)) | ||
| sections_list=$(IFS=,; echo "${unique_sections[*]}") | ||
|
|
||
| echo "sections=${sections_list}" >> $GITHUB_OUTPUT | ||
| echo "Affected sections: ${sections_list}" | ||
|
|
||
| - name: Create branch name | ||
| id: branch | ||
| run: | | ||
| # Create a unique branch name for the agent | ||
| timestamp=$(date +%s) | ||
| branch_name="mintlify-agent-review-pr-${{ github.event.number }}-${timestamp}" | ||
| echo "branch_name=${branch_name}" >> $GITHUB_OUTPUT | ||
|
|
||
| - name: Call Mintlify Agent API | ||
| id: agent-call | ||
| run: | | ||
| # Prepare the PR context message | ||
| PR_TITLE="${{ github.event.pull_request.title }}" | ||
| PR_BODY="${{ github.event.pull_request.body }}" | ||
| PR_URL="${{ github.event.pull_request.html_url }}" | ||
| CHANGED_FILES="${{ steps.changed-files.outputs.all_changed_files }}" | ||
| SECTIONS="${{ steps.sections.outputs.sections }}" | ||
|
|
||
| # Create the message content | ||
| MESSAGE_CONTENT="Review and improve the documentation changes in this PR: ${PR_URL} | ||
|
|
||
| PR Title: ${PR_TITLE} | ||
|
|
||
| PR Description: ${PR_BODY} | ||
|
|
||
| Changed files: ${CHANGED_FILES} | ||
|
|
||
| Affected documentation sections: ${SECTIONS} | ||
|
|
||
| Please review the changes and: | ||
| 1. Check for technical accuracy and completeness | ||
| 2. Ensure consistency with existing documentation style | ||
| 3. Verify that code examples are correct and up-to-date | ||
| 4. Update any related llms.txt files if necessary | ||
| 5. Fix any typos, grammar issues, or formatting problems | ||
| 6. Ensure proper cross-references and links are maintained | ||
| 7. Validate that the changes align with the overall documentation structure | ||
|
|
||
| Focus particularly on the sections: ${SECTIONS}" | ||
|
|
||
| # Prepare the JSON payload | ||
| cat > payload.json << EOF | ||
| { | ||
| "branch": "${{ steps.branch.outputs.branch_name }}", | ||
| "messages": [ | ||
| { | ||
| "role": "system", | ||
| "content": "You are a technical documentation expert helping to review and improve Base documentation. Focus on accuracy, clarity, and consistency with existing documentation patterns." | ||
| }, | ||
| { | ||
| "role": "user", | ||
| "content": "${MESSAGE_CONTENT}" | ||
| } | ||
| ] | ||
| } | ||
| EOF | ||
|
|
||
| echo "Calling Mintlify Agent API..." | ||
| echo "Project ID: ${{ secrets.MINTLIFY_PROJECT_ID }}" | ||
| echo "Branch: ${{ steps.branch.outputs.branch_name }}" | ||
|
|
||
| # Call the Mintlify Agent API | ||
| response=$(curl -X POST \ | ||
| "https://api.mintlify.com/v1/agent/${{ secrets.MINTLIFY_PROJECT_ID }}/job" \ | ||
| -H "Authorization: Bearer ${{ secrets.MINTLIFY_API_ADMIN_KEY }}" \ | ||
| -H "Content-Type: application/json" \ | ||
| -d @payload.json \ | ||
| -w "HTTPSTATUS:%{http_code}" \ | ||
| -s) | ||
|
|
||
| # Extract HTTP status and response body | ||
| http_status=$(echo $response | grep -o "HTTPSTATUS:[0-9]*" | cut -d: -f2) | ||
| response_body=$(echo $response | sed -E 's/HTTPSTATUS:[0-9]*$//') | ||
|
|
||
| echo "HTTP Status: ${http_status}" | ||
| echo "Response: ${response_body}" | ||
|
|
||
| if [ "$http_status" -eq 200 ]; then | ||
| echo "✅ Mintlify Agent API call successful" | ||
| echo "agent_success=true" >> $GITHUB_OUTPUT | ||
| echo "session_id=$(echo "$response" | grep -o 'X-Session-Id: [^[:space:]]*' | cut -d' ' -f2)" >> $GITHUB_OUTPUT | ||
| else | ||
| echo "❌ Mintlify Agent API call failed with status: ${http_status}" | ||
| echo "Response: ${response_body}" | ||
| echo "agent_success=false" >> $GITHUB_OUTPUT | ||
| exit 1 | ||
| fi | ||
|
|
||
| - name: Wait for agent completion | ||
| if: steps.agent-call.outputs.agent_success == 'true' | ||
| run: | | ||
| echo "⏳ Waiting for Mintlify Agent to complete the review..." | ||
| echo "This may take a few minutes depending on the complexity of the changes." | ||
|
|
||
| # Wait for a reasonable amount of time for the agent to process | ||
| # The agent works asynchronously, so we'll wait and then check if a branch was created | ||
| sleep 30 | ||
|
|
||
| echo "✅ Agent job submitted successfully!" | ||
| echo "Branch created: ${{ steps.branch.outputs.branch_name }}" | ||
| echo "You can monitor the progress in your Mintlify dashboard." | ||
|
|
||
| - name: Comment on PR | ||
| if: steps.agent-call.outputs.agent_success == 'true' | ||
| uses: actions/github-script@v7 | ||
| with: | ||
| script: | | ||
| const branchName = '${{ steps.branch.outputs.branch_name }}'; | ||
| const sections = '${{ steps.sections.outputs.sections }}'; | ||
|
|
||
| const comment = `## 🤖 Mintlify Agent Documentation Review | ||
|
|
||
| I've initiated a documentation review using the Mintlify Agent for this PR. | ||
|
|
||
| **Affected sections:** ${sections} | ||
| **Review branch:** \`${branchName}\` | ||
|
|
||
| The agent is analyzing the changes and will create a pull request with suggested improvements if any issues are found. This includes: | ||
|
|
||
| - ✅ Technical accuracy verification | ||
| - ✅ Style and formatting consistency | ||
| - ✅ Code example validation | ||
| - ✅ Cross-reference and link verification | ||
| - ✅ Grammar and typo corrections | ||
| - ✅ llms.txt updates if needed | ||
|
|
||
| You can monitor the progress in your [Mintlify dashboard](https://dashboard.mintlify.com). | ||
|
|
||
| *This review was automatically triggered by changes to documentation files.*`; | ||
|
|
||
| github.rest.issues.createComment({ | ||
| issue_number: context.issue.number, | ||
| owner: context.repo.owner, | ||
| repo: context.repo.repo, | ||
| body: comment | ||
| }); | ||
|
|
||
| - name: Handle API failure | ||
| if: steps.agent-call.outputs.agent_success == 'false' | ||
| uses: actions/github-script@v7 | ||
| with: | ||
| script: | | ||
| const comment = `## ❌ Mintlify Agent Review Failed | ||
|
|
||
| The automated documentation review could not be completed due to an API error. | ||
|
|
||
| Please check: | ||
| - Mintlify API credentials are correctly configured | ||
| - Project ID is valid | ||
| - API rate limits haven't been exceeded | ||
|
|
||
| You may need to manually review the documentation changes or retry the workflow.`; | ||
|
|
||
| github.rest.issues.createComment({ | ||
| issue_number: context.issue.number, | ||
| owner: context.repo.owner, | ||
| repo: context.repo.repo, | ||
| body: comment | ||
| }); | ||
|
|
||
| core.setFailed('Mintlify Agent API call failed'); |
Check warning
Code scanning / CodeQL
Workflow does not contain permissions Medium
Show autofix suggestion
Hide autofix suggestion
Copilot Autofix
AI 9 days ago
To fix the issue, an explicit permissions block should be added to the workflow so that the GitHub Actions runner only receives the minimum permissions required. The block should be placed at the top level of the workflow file, just after the name: and before jobs: (or just under on:). For this workflow, the required permissions are: contents: read (to check out repo and read files), and issues: write (to post comments on PRs using actions/github-script). No other write-level permission appears needed.
Specifically, add:
permissions:
contents: read
issues: writeto .github/workflows/mintlify-agent.yml, after on: (line 11), before jobs: (line 12).
No changes to imports, methods, or other workflow blocks are needed.
Suggested changeset
1
.github/workflows/mintlify-agent.yml
| @@ -9,6 +9,10 @@ | ||
| - 'docs/**/llms.txt' | ||
| - 'docs/**/llms-full.txt' | ||
|
|
||
| permissions: | ||
| contents: read | ||
| issues: write | ||
|
|
||
| jobs: | ||
| mintlify-agent-review: | ||
| runs-on: ubuntu-latest |
Copilot is powered by AI and may make mistakes. Always verify output.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What changed? Why?
Docs automation with Mintlify