diff options
| author | hathach <[email protected]> | 2026-06-30 13:26:53 +0700 |
|---|---|---|
| committer | hathach <[email protected]> | 2026-06-30 13:26:53 +0700 |
| commit | aa7db172caab24460592ec881d69f895f1a50e2b (patch) | |
| tree | cbd3f8e428b09e61c5e2ae725545f71f585a0a48 | |
| parent | 213e2725aa733e8b1a4dedae02984c1beedde8a3 (diff) | |
make-release skill: document code-size compare vs previous release
CI auto-uploads metrics.json + a compare to each release on the release event
(needs the previous release's metrics.json); plus the procedure to backfill a
missing baseline by building the old tag's own tree and post-processing its
linker maps (current tooling can't build old source — co-evolved tree).
Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
| -rw-r--r-- | .claude/skills/make-release/SKILL.md | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/.claude/skills/make-release/SKILL.md b/.claude/skills/make-release/SKILL.md index ad44d40c6..2c6388937 100644 --- a/.claude/skills/make-release/SKILL.md +++ b/.claude/skills/make-release/SKILL.md @@ -78,3 +78,21 @@ git push origin <branch> X.Y.Z ``` Then create a GitHub release from the `X.Y.Z` tag. + +## 5. Code size vs the previous release (CI-automatic) + +On the GitHub **release** event, `build.yml`'s `code-metrics` job builds the matrix with `--target tinyusb_metrics`, combines per-board `metrics.json`, downloads the **previous** tag's `metrics.json` (`gh release download $PREV -p metrics.json`), runs `metrics.py compare`, and uploads both `metrics.json` and `metrics_compare_<curr>-<prev>.md` to the release. No manual step — **provided the previous release has a `metrics.json` asset**. After releasing, confirm those two assets appeared. + +**Backfilling a missing baseline** (e.g. 0.20.0 predates the upload): do NOT try to graft current metrics tooling onto the old tag — the build system, `hw/bsp`, examples and `src/` are co-evolved (current `family_support.cmake` renamed cmake funcs the old example `CMakeLists` call; current `hw/bsp` uses newer `src/` APIs), so every build fails. Build the **old tag's own tree** and post-process its linker maps (0.20.0 already emits `*.elf.map` via `-Map`): + +```bash +git worktree add <wt> <OLD_TAG> && cd <wt> +# one board per arm-gcc family, all examples: +# for fam: python3 tools/get_deps.py <fam>; (cd examples && cmake -B build-<board> -DBOARD=<board> -GNinja -DCMAKE_BUILD_TYPE=MinSizeRel . && cmake --build build-<board>) +# old tag lacks linkermap/metrics.py — use the CURRENT checkout's copies: +for m in $(find examples -name '*.elf.map'); do python3 <CUR>/tools/linkermap/linkermap.py -j "$m"; done +python3 <CUR>/tools/metrics.py combine -j -m -f "$(pwd)/src" -o metrics $(find examples -name '*.map.json') +gh release upload <OLD_TAG> metrics.json +``` + +`metrics.py` keys units by **basename**, so the local absolute `-f <wt>/src` filter stays comparable to CI's `-f tinyusb/src`. Caveat: this is arm-gcc-only unless you also build the other CI toolchains (riscv/aarch64/…); files only built by those will show as spurious "added" in the next release's compare. |
