已合并
docs: update bot config guide md #106
fuyong创建于 7月22日
docs: update bot config guide md #106
已合并
共 1 个文件变更+11-11
| @@ -21,9 +21,9 @@ | |||
| 21 | 21 | ||
| 22 | | 层级 | 名称 | 配置文件位置 | 生效范围 | 维护人 | | 22 | | 层级 | 名称 | 配置文件位置 | 生效范围 | 维护人 | |
| 23 | |--------|------|-------------|----------|--------| | 23 | |--------|------|-------------|----------|--------| |
| 24 | -| 1（最高优先级） | 仓库个性配置 | 你的仓库根目录 `.bot-config.yaml` | 仅对本仓库生效，按 PR 目标分支隔离 | 仓库维护者 | | 24 | +| 1（最高优先级） | 仓库个性配置 | 你的仓库的 `.infra/robot.yaml` | 仅对本仓库生效，按 PR 目标分支隔离 | 仓库维护者 | |
| 25 | | 2 | 机器人服务仓库级默认配置 | 机器人服务内置 | 针对特定仓库的服务内置默认值 | 机器人服务管理员 | | 25 | | 2 | 机器人服务仓库级默认配置 | 机器人服务内置 | 针对特定仓库的服务内置默认值 | 机器人服务管理员 | |
| 26 | -| 3 | 组织配置 | `infrastructure` 仓库 `.bot-config.yaml` | 对整个组织下未命中第 1、2 层的仓库生效 | 组织管理员 | | 26 | +| 3 | 组织配置 | `infrastructure` 仓库 `.infra/robot.yaml` | 对整个组织下未命中第 1、2 层的仓库生效 | 组织管理员 | |
| 27 | | 4（最低优先级） | 机器人服务组织级默认配置 | 机器人服务内置 | 对组织下所有未命中以上三层的仓库生效 | 机器人服务管理员 | | 27 | | 4（最低优先级） | 机器人服务组织级默认配置 | 机器人服务内置 | 对组织下所有未命中以上三层的仓库生效 | 机器人服务管理员 | |
| 28 | 28 | ||
| 29 | **优先级：仓库个性配置 > 机器人服务仓库级默认配置 > 组织配置 > 机器人服务组织级默认配置** | 29 | **优先级：仓库个性配置 > 机器人服务仓库级默认配置 > 组织配置 > 机器人服务组织级默认配置** |
| @@ -39,21 +39,21 @@ | |||
| 39 | 39 | ||
| 40 | ### 2.1 配置文件位置 | 40 | ### 2.1 配置文件位置 |
| 41 | 41 | ||
| 42 | -在你的仓库**根目录**创建 `.bot-config.yaml` 文件，所有可自定义的功能配置均写在这一个文件中。 | 42 | +在你的仓库创建 `.infra/robot.yaml` 文件，所有可自定义的功能配置均写在这一个文件中。 |
| 43 | 43 | ||
| 44 | ### 2.2 按分支隔离 | 44 | ### 2.2 按分支隔离 |
| 45 | 45 | ||
| 46 | 机器人在处理每个 PR 时，以该 **PR 的目标分支**为准读取配置文件。即： | 46 | 机器人在处理每个 PR 时，以该 **PR 的目标分支**为准读取配置文件。即： |
| 47 | 47 | ||
| 48 | -- 合入 `main` 分支的 PR → 读取 `main` 分支根目录的 `.bot-config.yaml` | 48 | +- 合入 `main` 分支的 PR → 读取 `main` 分支的 `.infra/robot.yaml` |
| 49 | -- 合入 `release-1.0` 分支的 PR → 读取 `release-1.0` 分支根目录的 `.bot-config.yaml` | 49 | +- 合入 `release-1.0` 分支的 PR → 读取 `release-1.0` 分支的 `.infra/robot.yaml` |
| 50 | 50 | ||
| 51 | 你可以在不同分支分别维护不同的配置文件，分支之间互不影响。若某个分支上没有配置文件，该分支的 PR 将按优先级依次回退到机器人服务仓库级默认配置、组织配置、机器人服务组织级默认配置。 | 51 | 你可以在不同分支分别维护不同的配置文件，分支之间互不影响。若某个分支上没有配置文件，该分支的 PR 将按优先级依次回退到机器人服务仓库级默认配置、组织配置、机器人服务组织级默认配置。 |
| 52 | 52 | ||
| 53 | ### 2.3 创建配置文件 | 53 | ### 2.3 创建配置文件 |
| 54 | 54 | ||
| 55 | 1. 切换到目标分支（如 `main`）。 | 55 | 1. 切换到目标分支（如 `main`）。 |
| 56 | -2. 在仓库根目录创建 `.bot-config.yaml`。 | 56 | +2. 在仓库创建 `.infra/robot.yaml`。 |
| 57 | 3. 按[第 4 节](#4-可配置项说明)填写需要自定义的字段，**只需填写想覆盖的字段**，其余保持默认。 | 57 | 3. 按[第 4 节](#4-可配置项说明)填写需要自定义的字段，**只需填写想覆盖的字段**，其余保持默认。 |
| 58 | 4. 将文件提交到该分支。 | 58 | 4. 将文件提交到该分支。 |
| 59 | 5. 等待缓存刷新后配置生效（默认 10 分钟，首次创建文件最长需等待 60 分钟）。 | 59 | 5. 等待缓存刷新后配置生效（默认 10 分钟，首次创建文件最长需等待 60 分钟）。 |
| @@ -61,7 +61,7 @@ | |||
| 61 | **示例——只覆盖 lgtm 数量：** | 61 | **示例——只覆盖 lgtm 数量：** |
| 62 | 62 | ||
| 63 | ```yaml | 63 | ```yaml |
| 64 | -# .bot-config.yaml | 64 | +# .infra/robot.yaml |
| 65 | lgtm_need_nums: 2 | 65 | lgtm_need_nums: 2 |
| 66 | ``` | 66 | ``` |
| 67 | 67 | ||
| @@ -69,7 +69,7 @@ lgtm_need_nums: 2 | |||
| 69 | 69 | ||
| 70 | ## 3. 组织配置 | 70 | ## 3. 组织配置 |
| 71 | 71 | ||
| 72 | -组织配置由**组织管理员**统一维护，存放在组织内 `infrastructure` 仓库的 `.bot-config.yaml` 文件中。 | 72 | +组织配置由**组织管理员**统一维护，存放在组织内 `infrastructure` 仓库的 `.infra/robot.yaml` 文件中。 |
| 73 | 73 | ||
| 74 | 它的作用是为组织下所有仓库设置统一的默认值，仓库维护者无需重复配置。当某个仓库有自己的仓库个性配置时，该仓库会优先使用自己的配置，组织配置对该仓库不再生效。 | 74 | 它的作用是为组织下所有仓库设置统一的默认值，仓库维护者无需重复配置。当某个仓库有自己的仓库个性配置时，该仓库会优先使用自己的配置，组织配置对该仓库不再生效。 |
| 75 | 75 | ||
| @@ -79,7 +79,7 @@ lgtm_need_nums: 2 | |||
| 79 | 79 | ||
| 80 | ## 4. 可配置项说明 | 80 | ## 4. 可配置项说明 |
| 81 | 81 | ||
| 82 | -所有配置项写在同一个 `.bot-config.yaml` 文件中，按需填写： | 82 | +所有配置项写在同一个 `.infra/robot.yaml` 文件中，按需填写： |
| 83 | 83 | ||
| 84 | ```yaml | 84 | ```yaml |
| 85 | # PR 标签要求 | 85 | # PR 标签要求 |
| @@ -164,7 +164,7 @@ block_labels: | |||
| 164 | 164 | ||
| 165 | A：请检查以下几点： | 165 | A：请检查以下几点： |
| 166 | 1. 文件是否提交到了正确的分支（应与 PR 目标分支一致）。 | 166 | 1. 文件是否提交到了正确的分支（应与 PR 目标分支一致）。 |
| 167 | -2. 文件名是否为 `.bot-config.yaml`，路径是否在仓库根目录。 | 167 | +2. 文件路径是否为 `.infra/robot.yaml`。 |
| 168 | 3. YAML 格式是否有误（可使用在线 YAML 校验工具检查）。 | 168 | 3. YAML 格式是否有误（可使用在线 YAML 校验工具检查）。 |
| 169 | 4. 是否还在缓存期内（修改后最长等 10 分钟，首次创建最长等 60 分钟）。 | 169 | 4. 是否还在缓存期内（修改后最长等 10 分钟，首次创建最长等 60 分钟）。 |
| 170 | 170 | ||
| @@ -172,7 +172,7 @@ A：请检查以下几点： | |||
| 172 | 172 | ||
| 173 | **Q：没有配置文件的分支会受影响吗？** | 173 | **Q：没有配置文件的分支会受影响吗？** |
| 174 | 174 | ||
| 175 | -A：不会。目标分支没有 `.bot-config.yaml` 时，该分支的 PR 不受仓库个性配置影响，自动回退到组织配置或机器人服务默认配置（仓库级或组织级）。 | 175 | +A：不会。目标分支没有 `.infra/robot.yaml` 时，该分支的 PR 不受仓库个性配置影响，自动回退到组织配置或机器人服务默认配置（仓库级或组织级）。 |
| 176 | 176 | ||
| 177 | --- | 177 | --- |
| 178 | 178 | ||