跳转到主要内容
在 GitHub Actions 中使用 Cursor CLI 更新文档。提供两种方案:完全由代理自主执行,或采用确定性工作流,仅允许代理修改文件。
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 "cursoragent@cursor.com"

      - 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。

          # 上下文:
          - Repo: ${{ github.repository }}
          - Owner: ${{ github.repository_owner }}
          - PR Number: ${{ github.event.pull_request.number }}
          - Base Ref: ${{ github.base_ref }}
          - Head Ref: ${{ github.head_ref }}
          - Docs Branch Prefix: ${{ env.BRANCH_PREFIX }}

          # 目标:
          - 基于原始 PR 的增量变更,实施端到端的文档更新流程。

          # 要求:
          1) 确定原始 PR 中的变更内容;如有多次推送,自上次文档成功更新以来计算增量差异。
          2) 仅根据这些增量变更更新相关文档。
          3) 使用上下文中的文档分支前缀,为该 PR 的 head 维护一个持久化的文档分支;若不存在则创建,存在则更新,并将变更推送至 origin。
          4) 你无权创建 PR。请改为发布或更新一条自然语言 PR 评论(1–2 句),简要说明本次文档更新,并包含一个内联对比链接以便快速创建 PR。

          # 输入与约定:
          - 使用 `gh pr diff` 与 git 历史记录检测变更,并据此推导自上次文档更新以来的增量范围。
          - 不要尝试直接创建或编辑 PR。请使用上述对比链接格式。
          - 将变更保持最小且符合仓库风格。若无需更新文档,则不要做任何变更,也不要发布评论。

          # 更新发生时的交付物:
          - 将提交推送到该 PR head 的持久化文档分支。
          - 在原始 PR 上发布一条自然语言评论,包含上述内联对比链接。避免重复发布;如已有先前的机器人评论,请更新它。
          " --force --model "$MODEL" --output-format=text
I