summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorhathach <[email protected]>2026-06-30 09:10:50 +0700
committerhathach <[email protected]>2026-06-30 09:10:50 +0700
commitce23b8d72e18398873d4e5deb8e38206218aea3d (patch)
tree028dfa0abed206f514a591eb6e3352c8151b0fc5
parentc887bd907c6ca5d06c8db69039b2811079f7731c (diff)
Address Copilot review; move release process into the make-release skill
- README: restore the separate CH32V103 / CH583,CH582 rows in the Supported CPUs table — the merged row wrongly applied "ISO data loss [2]" to CH583/2 - Fix typos in historical changelog entries (santiy, Venndor, dynamnic, bagde, masstorage, techinical, walkaround, "Update Update") flagged by Copilot - Replace the AGENTS.md Release section with a pointer to the make-release skill; add a Finalize step (maintainer commit/tag/push + GitHub release) to the skill so nothing is lost Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
-rw-r--r--.claude/skills/make-release/SKILL.md14
-rw-r--r--AGENTS.md14
-rw-r--r--README.rst4
-rw-r--r--docs/info/changelog/0.11.0.rst2
-rw-r--r--docs/info/changelog/0.14.0.rst6
-rw-r--r--docs/info/changelog/0.15.0.rst4
-rw-r--r--docs/info/changelog/0.8.0.rst4
-rw-r--r--docs/info/changelog/0.9.0.rst2
8 files changed, 26 insertions, 24 deletions
diff --git a/.claude/skills/make-release/SKILL.md b/.claude/skills/make-release/SKILL.md
index 918031afc..8ef3f1443 100644
--- a/.claude/skills/make-release/SKILL.md
+++ b/.claude/skills/make-release/SKILL.md
@@ -5,7 +5,7 @@ description: Use when cutting a new TinyUSB release — bumping the version, run
# Cut a TinyUSB Release
-Mirrors CLAUDE.md "Release". **Do NOT commit or tag** — leave every change unstaged for maintainer review (they commit `Bump version to X.Y.Z`, then tag). Work in a worktree. Agree the target version `X.Y.Z` with the maintainer before starting (it is their call, not derivable from the diff).
+**Do NOT commit or tag** during prep — leave every change unstaged for maintainer review; the maintainer finalizes (commit, tag, release) in step 4. Work in a worktree. Agree the target version `X.Y.Z` with the maintainer before starting (it is their call, not derivable from the diff).
## 1. Bump version + regenerate files
@@ -67,3 +67,15 @@ git diff --stat -- ':!.idea' # review; `.idea/*`
```
Confirm version is consistent across `tusb_option.h` / `library.json` / `repository.yml` / `sonar-project.properties`, then leave everything unstaged for the maintainer.
+
+## 4. Finalize (maintainer)
+
+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
+```
+
+Then create a GitHub release from the `vX.Y.Z` tag.
diff --git a/AGENTS.md b/AGENTS.md
index e417d1710..e7db86cb7 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -195,19 +195,7 @@ Device examples need real hardware to validate runtime behavior; must at least b
## Release
-Use the `make-release` skill (`.claude/skills/make-release/SKILL.md`) for the full procedure — PR-set reconciliation, regenerated-file gotchas, and validation.
-
-**Do not commit automatically — leave changes for maintainer review.**
-
-1. Bump version at top of `tools/make_release.py`.
-2. Run `python3 tools/make_release.py` to refresh: `src/tusb_option.h`, `repository.yml`, `library.json`, `sonar-project.properties`, `docs/reference/boards.rst`, `hw/bsp/BoardPresets.json`.
-3. Changelog: add `docs/info/changelog/X.Y.Z.rst` and list it first in `docs/info/changelog/index.rst`:
- - Determine the PR set by commit reachability — `git log --first-parent <last-tag>..HEAD` — not by merge date (see the `make-release` skill; a date query misses squash merges and includes the prior release's own PR).
- - Read merged PRs for context (`gh pr view`, or github MCP tools).
- - Follow existing format: version title + `======` underline, italic date, sections (General, API Changes, Device Stack, Host Stack, DCD & HCD, Testing, Contributors) with driver/class groups as `^^^` sub-headings, RST inline code for symbols.
- - End with a **Contributors** section thanking the release's PR authors (unique non-bot `@handles`) — contributor credit lives here, not in a separate page.
-4. Validate: `ceedling test:all`, build `cdc_msc` for `stm32f407disco`, review `git diff --stat`.
-5. Leave unstaged. Maintainer commits `Bump version to X.Y.Z`, then: `git tag -a vX.Y.Z -m "Release X.Y.Z" && git push origin <branch> vX.Y.Z`. Create GitHub release from tag.
+Cutting a release — version bump, regenerated files, the per-release changelog, validation, and the maintainer's commit/tag/GitHub-release — is handled by the `make-release` skill (`.claude/skills/make-release/SKILL.md`).
## References
diff --git a/README.rst b/README.rst
index e4258dc17..94c90158a 100644
--- a/README.rst
+++ b/README.rst
@@ -311,7 +311,9 @@ Supported CPUs
| +-----------------------------+--------+------+-----------+------------------------+--------------------+
| | CH32V305, CH32V307 | 🟡 | | ✅ | ch32_usbfs/hs | ISO data loss [2]_ |
| +-----------------------------+--------+------+-----------+------------------------+--------------------+
-| | CH583/2, CH32V103 | 🟡 | | ❌ | ch32_usbfs | ISO data loss [2]_ |
+| | CH32V103 | 🟡 | | ❌ | ch32_usbfs | ISO data loss [2]_ |
+| +-----------------------------+--------+------+-----------+------------------------+--------------------+
+| | CH583, CH582 | 🟡 | | ❌ | ch32_usbfs | Device only |
+--------------+-----------------------------+--------+------+-----------+------------------------+--------------------+
Table Legend
diff --git a/docs/info/changelog/0.11.0.rst b/docs/info/changelog/0.11.0.rst
index b6330de6e..c27b027dd 100644
--- a/docs/info/changelog/0.11.0.rst
+++ b/docs/info/changelog/0.11.0.rst
@@ -36,7 +36,7 @@ RP2040
^^^^^^
- Add RP2040 suspend & resume support
-- Implement double buffer for both host and device (#891). However device EPOUT is still single buffered due to techinical issue with short packet
+- Implement double buffer for both host and device (#891). However device EPOUT is still single buffered due to technical issue with short packet
Device Stack
------------
diff --git a/docs/info/changelog/0.14.0.rst b/docs/info/changelog/0.14.0.rst
index dca587cf9..421e6d8d5 100644
--- a/docs/info/changelog/0.14.0.rst
+++ b/docs/info/changelog/0.14.0.rst
@@ -30,7 +30,7 @@ dwc2
- [EHCI] Fix an issue with EHCI driver
- [msp430] Fix for possible bug in msp430-elf-gcc 9.3.0
- [nrf5x] Fix DMA access race condition using atomic function
-- [pic32] Fix PIC32 santiy
+- [pic32] Fix PIC32 sanity
rp2040
^^^^^^
@@ -53,12 +53,12 @@ Device Stack
- [DFU] Fix coexistence with other interfaces BTH, RNDIS
- [MSC] Fix inquiry response additional length field
-- [Venndor] Improve write performance
+- [Vendor] Improve write performance
Host Stack
----------
-- Add new API ``tuh_configure(rhport, cfg_id, cfg_param)`` for dynamnic port specific behavior configuration
+- Add new API ``tuh_configure(rhport, cfg_id, cfg_param)`` for dynamic port specific behavior configuration
- [HID] Open OUT endpoint if available
- [Hub] hub clear port and device interrupts
diff --git a/docs/info/changelog/0.15.0.rst b/docs/info/changelog/0.15.0.rst
index 07b7a0d7b..f1d55f349 100644
--- a/docs/info/changelog/0.15.0.rst
+++ b/docs/info/changelog/0.15.0.rst
@@ -2,7 +2,7 @@
======
- Add codespell to detect typo
-- Add support for fuzzing and bagde for oss-fuzz
+- Add support for fuzzing and badge for oss-fuzz
osal
^^^^
@@ -72,7 +72,7 @@ Host Stack
----------
- Retry a few times with transfers in enumeration since device can be unstable when starting up
-- [MSC] Rework host masstorage API. Add new ``host/msc_file_explorer`` example
+- [MSC] Rework host mass storage API. Add new ``host/msc_file_explorer`` example
CDC
^^^
diff --git a/docs/info/changelog/0.8.0.rst b/docs/info/changelog/0.8.0.rst
index aaca9dcc4..38f51ba6b 100644
--- a/docs/info/changelog/0.8.0.rst
+++ b/docs/info/changelog/0.8.0.rst
@@ -18,7 +18,7 @@ ESP32-S2
SAMD21
^^^^^^
-- Fix (walkaround) samd21 setup_packet overflow by USB DMA
+- Fix (workaround) samd21 setup_packet overflow by USB DMA
STM32 Synopsys
^^^^^^^^^^^^^^
@@ -28,7 +28,7 @@ STM32 Synopsys
Sony CXD56
^^^^^^^^^^
-- Update Update Spresense SDK to 2.0.2
+- Update Spresense SDK to 2.0.2
- Fix dcd issues with setup packets
- Correct EP number for cdc_msc example
diff --git a/docs/info/changelog/0.9.0.rst b/docs/info/changelog/0.9.0.rst
index 92254a7f6..a48642144 100644
--- a/docs/info/changelog/0.9.0.rst
+++ b/docs/info/changelog/0.9.0.rst
@@ -13,7 +13,7 @@ RP2040
- Fix osal_pico queue overflow in initialization
- Fix Isochronous endpoint buffer size in transfer
- Optimize hardware endpoint struct to reduce RAM usage
-- Fix enum walkaround forever check for SE0 when pull up is disabled
+- Fix enum workaround forever check for SE0 when pull up is disabled
Sony CXD56
^^^^^^^^^^