执行摘要
本 PR 更新了贡献指南中 CI 斜杠命令的文档描述,使 /tag-run-ci-label、/rerun-failed-ci 和 /tag-and-rerun-ci 的行为更准确清晰。仅涉及两个文档文件,无代码变更,直接合并。
功能与动机
原有文档中,/tag-run-ci-label 的描述为 "Every future commit will trigger CI" ,贡献者容易误以为对当前提交也生效;而实际行为是只有 future commits 触发,当前不受影响。/rerun-failed-ci 也未说明会重试 skipped 状态的 workflow。PR 旨在消除歧义,明确告知贡献者在新 PR 上应使用 /tag-and-rerun-ci 来触发当前提交的 CI。
实现拆解
-
修改 docs/developer_guide/contribution_guide.md:
/tag-run-ci-label:从 "Adds the \"run-ci\" label. Every future commit will trigger CI." 改为 "Only future commits trigger CI; the current commit is unaffected."
/rerun-failed-ci:从 "Reruns the failed or flaky tests" 改为 "Reruns workflows from the latest commit with conclusion failed, flaky, or skipped."
/tag-and-rerun-ci:新增提示 "Use this on a fresh PR to kick off CI on the current commit — /tag-run-ci-label alone won't."
-
同步修改 docs/platforms/ascend/ascend_contribution_guide.md:
- 完全相同的内容变更,确保 Ascend 平台的文档与主指南一致。
-
无需测试或配置配套:纯文档修改。
无(纯文档变更)。
评论区精华
无实质性讨论。审核者 ispobock 直接批准。
风险与影响
- 风险:无。不影响任何代码逻辑或 CI 工作流。
- 影响:提升文档准确性和开发者体验,降低沟通成本。
关联脉络
该文档更新与 PR #24802(CI 斜杠命令 UX 改进)处于同一功能线,是对该功能的基础文档补充。
参与讨论