Add GitHub Action to automate the creation of LLMs.txt and LLMs-full.txt #5
Workflow file for this run
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: Update llms.txt and llms-full.txt in subdirectories | |
| on: | |
| pull_request: | |
| types: [opened, synchronize, reopened, ready_for_review] | |
| permissions: | |
| contents: write | |
| pull-requests: write | |
| jobs: | |
| auto-docs: | |
| if: ${{ !startsWith(github.head_ref, 'docs/') }} | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| ref: ${{ github.head_ref }} # Checkout the PR branch directly | |
| - name: Install Cursor CLI | |
| run: | | |
| curl https://cursor.com/install -fsS | bash | |
| echo "$HOME/.cursor/bin" >> $GITHUB_PATH | |
| - name: Configure git | |
| run: | | |
| git config user.name "Cursor Agent" | |
| git config user.email "cursoragent@cursor.com" | |
| - name: Detect changed subdirectories | |
| id: detect-changes | |
| run: | | |
| # Get list of changed files in docs/ directory | |
| changed_files=$(git diff --name-only origin/${{ github.base_ref }}...HEAD -- docs/) | |
| # Extract unique subdirectories that have llms.txt files | |
| changed_subdirs="" | |
| for file in $changed_files; do | |
| # Extract subdirectory (e.g., docs/base-account/file.mdx -> base-account) | |
| subdir=$(echo "$file" | sed -n 's|^docs/\([^/]*\)/.*|\1|p') | |
| if [ -n "$subdir" ] && [ -f "docs/$subdir/llms.txt" ] && [ -f "docs/$subdir/llms-full.txt" ]; then | |
| # Add to list if not already present | |
| if [[ ! "$changed_subdirs" =~ (^|[[:space:]])"$subdir"($|[[:space:]]) ]]; then | |
| changed_subdirs="$changed_subdirs $subdir" | |
| fi | |
| fi | |
| done | |
| # Clean up whitespace | |
| changed_subdirs=$(echo "$changed_subdirs" | xargs) | |
| echo "changed_subdirs=$changed_subdirs" >> $GITHUB_OUTPUT | |
| echo "Found changed subdirectories: $changed_subdirs" | |
| - name: Update docs for changed subdirectories | |
| if: steps.detect-changes.outputs.changed_subdirs != '' | |
| env: | |
| MODEL: gpt-5 | |
| CURSOR_API_KEY: ${{ secrets.CURSOR_API_KEY }} | |
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| CHANGED_SUBDIRS: ${{ steps.detect-changes.outputs.changed_subdirs }} | |
| run: | | |
| cursor-agent -p "You are operating in a GitHub Actions runner to update documentation summary files. | |
| The GitHub CLI is available as \`gh\` and authenticated via \`GH_TOKEN\`. Git is available. You have write access to repository contents and can comment on pull requests. | |
| # Context: | |
| - Repo: ${{ github.repository }} | |
| - Owner: ${{ github.repository_owner }} | |
| - PR Number: ${{ github.event.pull_request.number }} | |
| - Base Ref: ${{ github.base_ref }} | |
| - Head Ref: ${{ github.head_ref }} | |
| - Changed Subdirectories: $CHANGED_SUBDIRS | |
| - Current Branch: ${{ github.head_ref }} (you are already on the PR branch) | |
| # Goal: | |
| Update the llms.txt and llms-full.txt files in the changed subdirectories and commit directly to the current PR branch. | |
| # Requirements: | |
| 1) For each subdirectory in CHANGED_SUBDIRS, analyze what changed in that subdirectory since the base branch. | |
| 2) Update ONLY the llms.txt and llms-full.txt files in those specific subdirectories (e.g., docs/base-account/llms.txt, docs/base-account/llms-full.txt). | |
| 3) DO NOT update the root-level llms.txt or llms-full.txt files. | |
| 4) The llms.txt should be a concise summary/index of the documentation in that subdirectory. | |
| 5) The llms-full.txt should be a comprehensive guide with code examples and detailed explanations. | |
| 6) Maintain the existing format and style of these files. | |
| 7) ONLY commit and push changes if there are actual updates needed to the llms files. | |
| 8) If no updates are needed, do NOT create any commits or comments. | |
| 9) Commit directly to the current PR branch (${{ github.head_ref }}) - do NOT create separate branches. | |
| 10) If you make changes, add a simple comment to the PR explaining what was updated. | |
| # File Structure Context: | |
| Each subdirectory (base-account, base-app, base-chain, cookbook, get-started, learn, mini-apps, onchainkit) contains: | |
| - Multiple .mdx documentation files | |
| - An llms.txt file (concise summary/index) | |
| - An llms-full.txt file (comprehensive guide with code examples) | |
| # Instructions: | |
| 1) Use \`gh pr diff ${{ github.event.pull_request.number }}\` to see what changed in the PR for the specific subdirectories. | |
| 2) Read the current llms.txt and llms-full.txt files in each changed subdirectory. | |
| 3) Scan the .mdx files in each changed subdirectory to understand the content. | |
| 4) Update the llms.txt and llms-full.txt files ONLY if the changes warrant updates to the summaries. | |
| 5) If you make updates, commit them with a clear message like 'docs: update llms summaries for [subdirectory]'. | |
| 6) Push the commit to the current branch. | |
| 7) Add a brief comment to the PR explaining what was updated. | |
| 8) If no updates are needed, do nothing - no commits, no comments, no branches. | |
| # Important: Avoid Getting Stuck | |
| - If there are no changes to make, simply exit without doing anything. | |
| - Do not create empty commits or branches. | |
| - Do not post comments if no changes were made. | |
| # Workflow: | |
| 1. Check what changed → 2. Determine if llms files need updates → 3. If yes: update, commit, push, comment → 4. If no: do nothing and exit | |
| " --force --model "$MODEL" --output-format=text |