执行摘要

• 一句话：为文档构建预检查添加 GH token 提升 API 速率限制
• 推荐动作：可直接合入，无需额外测试。推荐熟悉文档构建流程的人关注环境变量 GITHUB_TOKEN 的配置。

功能与动机

解决文档构建（Read the Docs）中预检查步骤因 GitHub API 匿名请求速率限制（60 次/小时）而失败的问题。通过注入 GitHub token 将限制提升至 5000 次/小时，确保构建稳定。

实现拆解

1. 环境变量读取：在 docs/pre_run_check.sh 中检查 $GITHUB_TOKEN 是否非空。
2. 条件构造认证头：若 token 存在，则向 curl 添加 -H "Authorization: Bearer $GITHUB_TOKEN" 参数数组 CURL_AUTH。
3. 修改 API 调用：将原有的 curl 请求 curl -sS -w "\n%{http_code}" ... 改为使用 CURL_AUTH[@] 进行认证，从而提升速率限制。

关键文件：

• docs/pre_run_check.sh（模块 文档；类别 infra；类型 core-logic）: 核心变更文件，添加了 GitHub token 支持以提升 API 速率限制。

关键符号：未识别

关键源码片段

docs/pre_run_check.sh

核心变更文件，添加了 GitHub token 支持以提升 API 速率限制。

# 使用 GitHub token 提升 API 速率限制（60 -> 5000 请求 / 小时）
# 设置 GITHUB_TOKEN 环境变量（在 Read the Docs 配置中）
CURL_AUTH=()
if [ -n "$GITHUB_TOKEN" ]; then
  CURL_AUTH=(-H "Authorization: Bearer $GITHUB_TOKEN")
fi
​
# 在循环中，携带认证头发起请求
RAW=$(curl -sS "${CURL_AUTH[@]}" -w "\n%{http_code}" \
  "https://api.github.com/repos/vllm-project/vllm/commits/${READTHEDOCS_GIT_COMMIT_HASH}/check-runs?check_name=pre-run-check&filter=latest")

评论区精华

无 review 评论。

• 暂无高价值评论线程

风险与影响

• 风险：风险极低：仅修改文档构建辅助脚本，不影响任何运行时逻辑。若 token 无效或缺失，脚本回退到匿名请求（与原行为一致），无破坏性。
• 影响：影响范围限于 Read the Docs 文档构建流程，减少因速率限制导致的构建失败，提升文档部署可靠性。对其他系统、用户无影响。
• 风险标记：暂无

关联脉络

• 暂无明显关联 PR