已合并
docs: update bot config guide md #106
docs: update bot config guide md #106
已合并
fuyong创建于 7月22日
fuyong
fuyong成员
7月22日

变更描述 / Description

考虑到基础设施后续可能有更多的可自助配置文档(CLA/CVE服务等),为了便于扩展,所以调整机器人配置文档到.infra目录下

改动类型 / Change Type

  • Closes #
  • References #

测试信息 / Testing

检查清单 / Checklist

likedislike
Pull Request已成功合入, 合并人@CANN-robot
(感谢 fuyong 的贡献)
atomgit-bot
atomgit-bot
7月22日 评论:

变更摘要

此 PR 是一个文档更新,主要将机器人配置文档从原有位置迁移到 .infra 目录下。考虑到基础设施未来可能包含更多可自助配置的文档(如 CLA、CVE 服务等),将机器人配置文档统一归入 .infra 目录以便于扩展和维护。

主要改动

  • 文档目录结构调整:将机器人配置文档移动至 .infra 目录,为后续基础设施相关自助配置文档(CLA/CVE 等)的统一管理奠定基础。
  • 内容无实质性变更:文档仅进行路径迁移,新增与删除行数一致(均为 11 行),文档内容本身未做修改。
likedislike
atomgit-bot
atomgit-bot
7月22日 评论:

代码审查

已完成审查。以下是总结:


审查总结

变更文件: docs/robot/bot_config_guide.md(已审查 ✓)

发现问题:

优先级 数量
P0 0
P1 0
P2 1
P3 0

整体风险评估: 中等风险。此变更将配置文件路径从仓库根目录的 .bot-config.yaml 迁移到 .infra/robot.yaml(子目录),但文档中 6 处位置仍保留"仓库根目录"的旧表述,与新的 .infra/ 子目录路径产生直接矛盾。这可能导致用户将配置文件放错位置(放在根目录而非 .infra/ 目录下),造成机器人无法读取自定义配置,用户的自助配置完全失效。FAQ 排查指引(第 167 行)中的矛盾尤为危险——它可能在用户正确放置文件后,反而引导用户将其移到错误位置。修复方案是将"根目录"替换为与 .infra/ 子目录一致的准确表述,并在创建步骤中补充创建 .infra/ 目录的指引。

类型 数量
🔴 阻塞 0
🟡 建议 1

💬 仅评论

likedislike
CANN-robotCANN-robot成员
7月22日 添加了label:cann-cla/yes
CANN-robot
CANN-robot成员
7月22日 评论:

Thanks for your pull-request.
The full list of commands accepted by me can be found at here
You can get sig-info at here


PR Approval Progress

Congratulations! All modules have met the lgtm and approve requirements.

Module Approval Details

module lgtm status approve status
repo-cann/infrastructure 李超然, 宋常霞 (2/2) 李超然, 宋常霞 (2/1)

💡 Tip:

  • Committer can comment /approve or /lgtm
  • Commenting /approve implies both code review (lgtm) and intent to merge (approve)

CLA Signature Pass

Coopermassaki, thanks for your pull request. All authors of the commits have signed the CLA. 👍

likedislike
fuyongfuyong成员
7月22日 修改了pull request 的描述
atomgit-bot
atomgit-bot7月22日进行代码检视2
docs/robot/bot_config_guide.md
已过期
@@ -22,3 +22,3 @@
2222| 层级 | 名称 | 配置文件位置 | 生效范围 | 维护人 |
2323|--------|------|-------------|----------|--------|
24-| 1(最高优先级) | 仓库个性配置 | 你的仓库根目录 `.bot-config.yaml` | 仅对本仓库生效,按 PR 目标分支隔离 | 仓库维护者 |
24+| 1(最高优先级) | 仓库个性配置 | 你的仓库根目录 `.infra/robot.yaml` | 仅对本仓库生效,按 PR 目标分支隔离 | 仓库维护者 |
atomgit-bot
atomgit-bot7月22日评论:

🟡 Medium Priority

文档中多处同时出现"仓库根目录"和路径 .infra/robot.yaml,两者存在矛盾:.infra/robot.yaml 中的 / 是目录分隔符,表示文件在 .infra/ 子目录下,而非仓库根目录。

受影响的行:

  • 第 24 行:你的仓库根目录 \.infra/robot.yaml``
  • 第 42 行:在你的仓库**根目录**创建 \.infra/robot.yaml` 文件`
  • 第 48 行:读取 \main` 分支根目录的 `.infra/robot.yaml``
  • 第 49 行:读取 \release-1.0` 分支根目录的 `.infra/robot.yaml``
  • 第 56 行:在仓库根目录创建 \.infra/robot.yaml``
  • 第 167 行:文件名是否为 \.infra/robot.yaml`,路径是否在仓库根目录`

第 167 行尤为严重:将 .infra/robot.yaml 称为"文件名",但实际上它是路径(文件名为 robot.yaml,位于 .infra/ 目录),且声称"路径在仓库根目录"——这与实际的 .infra/ 子目录位置矛盾。

触发条件:用户按照"仓库根目录"的指引,将文件直接放在根目录(如命名为字面值 .infra/robot.yaml 或仅 robot.yaml),而非正确的 .infra/robot.yaml 子目录路径。

失效模式:机器人服务按 .infra/robot.yaml 路径查找配置文件,在仓库根目录找不到,导致用户的自定义配置不生效,PR 行为回退到组织默认配置,用户无法自助调整机器人行为。

PR 描述确认了意图:"调整机器人配置文档到.infra目录下"——说明文件确实应在 .infra/ 子目录中。

likedislike
System
系统消息系统
7月23日 评论:

changed this line on b664780a view diff detail

fuyongfuyong成员
7月23日 强制推送  1 个提交:b664780a-docs: update bot config guide md
fuyongfuyong成员
7月23日 解决了最后一个问题
李超然
李超然成员
7月23日 评论:

/lgtm
/approve

likedislike
CANN-robotCANN-robot成员
7月23日 添加了label:approved
songchangxia成员
7月23日 评论:

/lgtm
/approve

likedislike
CANN-robotCANN-robot成员
7月23日 添加了label:lgtm
CANN-robotCANN-robot成员
7月23日 合入了pull request