更新文档

使用 Cursor CLI 在 GitHub Actions 中为仓库更新文档

在 GitHub Actions 中用 Cursor CLI 更新文档。支持两种方式：全权交给代理自主处理，或采用确定性流程，仅允许代理修改文件。

auto-update-docs.yml

name: 更新文档

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: 检出仓库
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: 安装 Cursor CLI
        run: |
          curl https://cursor.com/install -fsS | bash
          echo "$HOME/.cursor/bin" >> $GITHUB_PATH

      - name: 配置 git
        run: |
          git config user.name "Cursor Agent"
          git config user.email "[e-mail]"

      - name: 更新文档
        env:
          MODEL: gpt-5
          CURSOR_API_KEY: ${{ secrets.CURSOR_API_KEY }}
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          BRANCH_PREFIX: docs
        run: |
          cursor-agent -p "你正在 GitHub Actions 运行器中操作。

          GitHub CLI 以 `gh` 提供，并通过 `GH_TOKEN` 完成了认证。已提供 Git。你对仓库内容有写入权限，也可以在拉取请求上发表评论，但不能创建或编辑 PR。

          # 上下文：
          - 仓库：${{ github.repository }}
          - 所有者：${{ github.repository_owner }}
          - PR 编号：${{ github.event.pull_request.number }}
          - 基准分支：${{ github.base_ref }}
          - 头部分支：${{ github.head_ref }}
          - 文档分支前缀：${{ env.BRANCH_PREFIX }}

          # 目标：
          - 基于原始 PR 的增量变更，实现端到端的文档更新流程。

          # 要求：
          1) 判定原始 PR 中的变更；若发生多次 push，需计算自上次成功文档更新以来的增量 diff。
          2) 仅基于这些增量变更更新相关文档。
          3) 使用上下文中的文档分支前缀，为此 PR 的 head 维护一个持久化文档分支：如不存在则创建，存在则更新，并将变更推送到 origin。
          4) 你无权创建 PR。改为发布或更新一条自然语言 PR 评论（1–2 句），简要说明文档更新，并包含一个内联 compare 链接以快速创建 PR。

          # 输入与约定：
          - 使用 `gh pr diff` 和 git 历史来检测变更，并据此推导自上次文档更新以来的增量范围。
          - 不要直接尝试创建或编辑 PR。请使用上述 compare 链接格式。
          - 变更需最小化并符合仓库风格。如无需更新文档，则不做任何变更也不发表评论。

          # 有更新时的交付物：
          - 将提交推送到该 PR head 的持久化文档分支。
          - 在原始 PR 上发布一条自然语言评论，包含上述内联 compare 链接。避免重复发布；如已存在机器人评论则进行更新。
          " --force --model "$MODEL" --output-format=text