mirror/tinyusb
3
0
Fork 0
mirror of https://github.com/hathach/tinyusb.git synced 2026-08-18 11:02:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

Address Codex review: release skill + furo requirement

Browse Source 
- 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) <noreply@anthropic.com>
This commit is contained in:
hathach
2026-06-30 10:23:36 +07:00
parent ebb2bbe310
commit 0657ecf728
2 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
.claude/skills/make-release/SKILL.md
View File

@ -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.

2
docs/requirements.txt
View File

@ -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