Mettre à jour la doc

Mettre à jour la documentation d’un dépôt avec Cursor CLI dans GitHub Actions

Mets à jour la doc avec Cursor CLI dans GitHub Actions. Deux approches : autonomie complète de l’agent ou workflow déterministe avec modifications de fichiers limitées à l’agent.

auto-update-docs.yml

name: Update Docs

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

      - 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 "[e-mail]"

      - name: Update docs
        env:
          MODEL: gpt-5
          CURSOR_API_KEY: ${{ secrets.CURSOR_API_KEY }}
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          BRANCH_PREFIX: docs
        run: |
          cursor-agent -p "Tu opères dans un runner GitHub Actions.

          Le CLI GitHub est disponible sous `gh` et authentifié via `GH_TOKEN`. Git est disponible. Tu as un accès en écriture au contenu du dépôt et tu peux commenter les pull requests, mais tu ne dois pas créer ni modifier de PR.

          # Contexte :
          - Dépôt : ${{ github.repository }}
          - Propriétaire : ${{ github.repository_owner }}
          - Numéro de PR : ${{ github.event.pull_request.number }}
          - Base ref : ${{ github.base_ref }}
          - Head ref : ${{ github.head_ref }}
          - Préfixe de branche docs : ${{ env.BRANCH_PREFIX }}

          # Objectif :
          - Mettre en place un flux de mise à jour de la doc de bout en bout, piloté par les changements incrémentaux de la PR d'origine.

          # Exigences :
          1) Déterminer ce qui a changé dans la PR d'origine et, s'il y a eu plusieurs pushs, calculer les diffs incrémentaux depuis la dernière mise à jour réussie de la doc.
          2) Mettre à jour uniquement la doc pertinente en fonction de ces changements incrémentaux.
          3) Maintenir la branche de doc persistante pour ce head de PR en utilisant le préfixe de branche docs du Contexte. La créer si elle n'existe pas, sinon la mettre à jour, puis pousser les changements vers origin.
          4) Tu n'as PAS l'autorisation de créer des PR. À la place, publie ou mets à jour un seul commentaire en langage naturel sur la PR (1–2 phrases) qui explique brièvement les mises à jour de la doc et inclut un lien de comparaison inline pour créer rapidement une PR.

          # Entrées et conventions :
          - Utilise `gh pr diff` et l'historique git pour détecter les changements et dériver les plages incrémentales depuis la dernière mise à jour de la doc.
          - N'essaie pas de créer ou de modifier des PR directement. Utilise le format de lien de comparaison ci-dessus.
          - Garde les changements minimaux et cohérents avec le style du dépôt. S'il n'y a pas de mises à jour de doc nécessaires, ne fais aucun changement et ne publie aucun commentaire.

          # Livrables en cas de mises à jour :
          - Commits poussés vers la branche de doc persistante pour ce head de PR.
          - Un seul commentaire en langage naturel sur la PR d'origine qui inclut le lien de comparaison inline ci-dessus. Évite les doublons ; mets à jour un précédent commentaire du bot si présent.
          " --force --model "$MODEL" --output-format=text