Skip to content

Commit 7e88d01

Browse files
committed
docs: the contributing and release skills and the README badge describe the staged CI
1 parent 6f42afb commit 7e88d01

4 files changed

Lines changed: 15 additions & 13 deletions

File tree

‎.agents/skills/mcpp-contributing/SKILL.md‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -182,14 +182,16 @@ gh pr checks <pr-number> # 查看状态
182182
gh run view <run-id> --log-failed # 查看失败日志
183183
```
184184

185-
CI 由分平台的基础构建/单元集成检查与独立 E2E 检查组成:
186-
| Workflow | 平台 | 内容 |
187-
|----------|------|------|
188-
| `ci-linux` / `ci-linux-e2e` | Linux x86_64 | 自举构建、unit/integration / 分片 E2E |
189-
| `ci-macos` / `ci-macos-e2e` | macOS ARM64 | 自举构建、unit/integration / E2E |
190-
| `ci-windows` / `ci-windows-e2e` | Windows x86_64 | 自举构建、toolchain 回归 / E2E |
191-
| `cross-build-test` | Linux/Windows cross targets | 交叉构建、产物运行与 MinGW/Wine 检查 |
192-
| `ci-aarch64-fresh-install` | Linux ARM64 native | path-filtered fresh install、原生自举与 musl `build.mcpp` host-helper 回归 |
185+
一次提交的 CI 是 `ci.yml` 的一次运行,分段执行(设计见 `.agents/docs/2026-10-02-pr-ci-acceleration-and-the-toolchain-specification-design.md` 第二部分):
186+
| 阶段 | 内容 |
187+
|------|------|
188+
| `changes` | 按改动路径分类;只改了没有任何脚本、测试或源码读取的文档时,只跑 `docs` |
189+
| `docs` | 不需要二进制的检查(版本钉、文档风格与结构、工作流断言等) |
190+
| `build-*` | 每个宿主构建一次 mcpp(`build.yml`),上传为 `mcpp-built-<host>` |
191+
| `linux` / `linux-e2e`、`macos` / `macos-e2e` / `macos-ios`、`windows` / `windows-e2e` / `windows-msvc-xlings`、`cross`、`target-matrix`、`openkal` | 各领域的可复用工作流(原来的 `ci-*.yml`),通过 `.github/actions/use-built-mcpp` 使用上面那次构建,不再各自构建 |
192+
| `e2e-coverage` | 每个 e2e 测试都在某个宿主上运行、由专门 job 运行,或在 `tests/e2e/coverage-exceptions.tsv` 中写明原因 |
193+
194+
`ci-aarch64-fresh-install`、`measure-windows-tool-crt` 与 `pypi-publish` 仍是按路径触发的独立工作流。缓存只在 main 上由一个 job 保存;PR 只恢复。
193195

194196
**以 PR 实际 required checks 为准,所有未跳过的 required checks 必须通过。** 如果某个平台失败:
195197
1. 下载日志分析原因

‎.agents/skills/mcpp-release/SKILL.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,9 @@ gh run list --branch main --limit 3
7373
```
7474

7575
以分支保护和 `gh pr checks <pr-number>` 显示的 actual required checks 为准。
76-
在 main 上监控当前运行时,检查 `ci-linux`、`ci-linux-e2e`、`ci-macos`、
77-
`ci-macos-e2e`、`ci-windows`、`ci-windows-e2e` 与 `cross-build-test` 的结果;
78-
跳过或非 required 的 workflow 不是合入 gate。不要在 required CI 红的时候发版。
76+
在 main 上监控当前运行时,检查 `ci` 这一个工作流的运行(它包含各平台、e2e 分片、
77+
交叉构建与 `e2e-coverage`);known-red 的腿(名字里带 issue 号)允许失败。跳过或
78+
非 required 的 workflow 不是合入 gate。不要在 `ci` 红的时候发版。
7979

8080
### 2. bump 版本号(第一组两处,单个 commit,走 PR)
8181

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
| [Documentation](docs/) · [Getting Started](docs/01-getting-started.md) · [mcpp.toml Guide](docs/04-mcpp-toml.md) · [Examples](docs/03-examples.md) · [Toolchains](docs/20-toolchains.md) |
1313
|:---:|
1414
| [Package index mcpp-index](https://mcpplibs.github.io/mcpp-index/) · [Module libraries mcpplibs](https://github.com/mcpplibs) · [Community Forum](https://forum.d2learn.org/category/20) · [Issues](https://github.com/mcpp-community/mcpp/issues) · [Releases](https://github.com/mcpp-community/mcpp/releases) |
15-
| [![ci-linux](https://github.com/mcpp-community/mcpp/actions/workflows/ci-linux.yml/badge.svg?branch=main)](https://github.com/mcpp-community/mcpp/actions/workflows/ci-linux.yml) [![ci-macos](https://github.com/mcpp-community/mcpp/actions/workflows/ci-macos.yml/badge.svg?branch=main)](https://github.com/mcpp-community/mcpp/actions/workflows/ci-macos.yml) [![ci-windows](https://github.com/mcpp-community/mcpp/actions/workflows/ci-windows.yml/badge.svg?branch=main)](https://github.com/mcpp-community/mcpp/actions/workflows/ci-windows.yml) |
15+
| [![ci](https://github.com/mcpp-community/mcpp/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/mcpp-community/mcpp/actions/workflows/ci.yml) |
1616
| Plugins · [mcpp-language-server (mcppls)](https://github.com/Sunrisepeak/mcpp-language-server) — a C++20/23 modules language server for VS Code, Zed, CLion, Neovim, AI agents (MCP) and CI |
1717

1818
<p align="center">

‎README.zh-CN.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
| [文档](docs/zh/) · [快速开始](docs/zh/01-getting-started.md) · [mcpp.toml 指南](docs/zh/04-mcpp-toml.md) · [示例项目](docs/zh/03-examples.md) · [工具链管理](docs/zh/20-toolchains.md) |
1313
|:---:|
1414
| [包索引 mcpp-index](https://mcpplibs.github.io/mcpp-index/) · [模块化库 mcpplibs](https://github.com/mcpplibs) · [社区论坛](https://forum.d2learn.org/category/20) · [Issues](https://github.com/mcpp-community/mcpp/issues) · [Releases](https://github.com/mcpp-community/mcpp/releases) |
15-
| [![ci-linux](https://github.com/mcpp-community/mcpp/actions/workflows/ci-linux.yml/badge.svg?branch=main)](https://github.com/mcpp-community/mcpp/actions/workflows/ci-linux.yml) [![ci-macos](https://github.com/mcpp-community/mcpp/actions/workflows/ci-macos.yml/badge.svg?branch=main)](https://github.com/mcpp-community/mcpp/actions/workflows/ci-macos.yml) [![ci-windows](https://github.com/mcpp-community/mcpp/actions/workflows/ci-windows.yml/badge.svg?branch=main)](https://github.com/mcpp-community/mcpp/actions/workflows/ci-windows.yml) |
15+
| [![ci](https://github.com/mcpp-community/mcpp/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/mcpp-community/mcpp/actions/workflows/ci.yml) |
1616
| 支持的插件 · [mcpp-language-server(mcppls)](https://github.com/Sunrisepeak/mcpp-language-server) —— C++20/23 模块语言服务器,面向 VS Code、Zed、CLion、Neovim、AI Agent(MCP)与 CI |
1717

1818
<p align="center">

0 commit comments

Comments
 (0)