summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorhathach <[email protected]>2026-06-30 10:23:36 +0700
committerhathach <[email protected]>2026-06-30 10:23:36 +0700
commit0657ecf72839dbed263624af524d10d77d9c2b06 (patch)
treeed75162feb26e48e54c454e7e8cde4c3f6744411
parentebb2bbe3108b27563a190153f6b8a40e9023547c (diff)
Address Codex review: release skill + furo requirement
- make-release skill: stage new files with git add -A in finalize, use unprefixed release tags (X.Y.Z), and run validate build steps in subshells so the cwd doesn't leak between commands - docs/requirements.txt: require furo>=2025.12.19 so the sidebar component list in conf.py (incl. variant-selector.html) is always available Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
-rw-r--r--.claude/skills/make-release/SKILL.md14
-rw-r--r--docs/requirements.txt2
2 files changed, 8 insertions, 8 deletions
diff --git a/.claude/skills/make-release/SKILL.md b/.claude/skills/make-release/SKILL.md
index 8ef3f1443..3b5bcff1e 100644
--- a/.claude/skills/make-release/SKILL.md
+++ b/.claude/skills/make-release/SKILL.md
@@ -60,9 +60,9 @@ pre-commit run --files docs/info/changelog/X.Y.Z.rst docs/info/changelog/index.r
docs/reference/boards.rst docs/reference/dependencies.rst \
library.json repository.yml sonar-project.properties src/tusb_option.h tools/make_release.py
python3 tools/build_doc.py -c # docs build clean; new release page wired into the toctree (see build-doc skill)
-cd test/unit-test && ceedling test:all # expect all pass
-cd examples/device/cdc_msc && rm -rf build && mkdir build && cd build && \
- cmake -DBOARD=stm32f407disco -G Ninja -DCMAKE_BUILD_TYPE=MinSizeRel .. && cmake --build .
+( cd test/unit-test && ceedling test:all ) # expect all pass
+( cd examples/device/cdc_msc && rm -rf build && mkdir build && cd build && \
+ cmake -DBOARD=stm32f407disco -G Ninja -DCMAKE_BUILD_TYPE=MinSizeRel .. && cmake --build . )
git diff --stat -- ':!.idea' # review; `.idea/*` is IDE noise, exclude it
```
@@ -73,9 +73,9 @@ Confirm version is consistent across `tusb_option.h` / `library.json` / `reposit
After reviewing the unstaged diff:
```bash
-git commit -am "Bump version to X.Y.Z"
-git tag -a vX.Y.Z -m "Release X.Y.Z"
-git push origin <branch> vX.Y.Z
+git add -A && git commit -m "Bump version to X.Y.Z" # -A so the new changelog file is staged
+git tag -a X.Y.Z -m "Release X.Y.Z" # tags are unprefixed (e.g. 0.20.0, not v0.20.0)
+git push origin <branch> X.Y.Z
```
-Then create a GitHub release from the `vX.Y.Z` tag.
+Then create a GitHub release from the `X.Y.Z` tag.
diff --git a/docs/requirements.txt b/docs/requirements.txt
index c94a3dd30..5ac42f097 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -1,5 +1,5 @@
sphinx>=5.0
-furo>=2020.12.30.b24
+furo>=2025.12.19
sphinx-autodoc-typehints>=1.10
myst-parser>=4.0
jinja2>=3.0.3