ci-docs-stats.yml

# Keep the GitHub star figures quoted in the docs in sync with the live repository.
#
# The star count is quoted on the docs landing page, in the three llms*.txt summaries, and
# as a number in mkdocs.yml. This job checks monthly and opens a PR when any of them has
# drifted.

name: Refresh Docs Stats

on:
  schedule:
    # 05:00 UTC on the first day of each month
    - cron: "0 5 1 * *"
  workflow_dispatch:

permissions:
  contents: write
  pull-requests: write

concurrency:
  group: ${{ github.workflow }}
  cancel-in-progress: true

jobs:
  refresh:
    name: Refresh docs stats
    runs-on: ubuntu-latest
    timeout-minutes: 10
    steps:
      - name: 📥 Checkout the repository
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

      - name: 🌿 Name the monthly refresh branch
        id: branch
        run: echo "name=chore/refresh-docs-stats-$(date -u +%Y-%m)" >> "$GITHUB_OUTPUT"

      - name: 🔢 Apply current star count
        env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: python .github/scripts/update_docs_stats.py

      # The action is a no-op when the script found no drift, so no separate diff gate is
      # needed. It creates the branch and PR on first run of a month and amends both on
      # any later run, rather than stacking duplicate PRs.
      - name: 🚀 Open refresh PR
        uses: peter-evans/create-pull-request@5f6978faf089d4d20b00c7766989d076bb2fc7f1 # v8.1.1
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          branch: ${{ steps.branch.outputs.name }}
          base: develop
          add-paths: |
            docs/index.md
            docs/llms.txt
            docs/llms.full.txt
            docs/llms-100k.txt
            mkdocs.yml
          commit-message: "docs: refresh quoted GitHub star count"
          title: "docs: refresh quoted GitHub star count"
          body: |
            Automated refresh: the star count quoted in the docs has drifted from the live
            repository.

            Generated by `.github/workflows/ci-docs-stats.yml`.
          delete-branch: true