diff options
| author | hathach <[email protected]> | 2026-06-29 23:38:01 +0700 |
|---|---|---|
| committer | hathach <[email protected]> | 2026-06-29 23:38:01 +0700 |
| commit | c887bd907c6ca5d06c8db69039b2811079f7731c (patch) | |
| tree | 3c09c32054da1d7195e8265467e0ed2538a0da41 /AGENTS.md | |
| parent | 40f4c12c6be504031d2e2808f191134739206b5e (diff) | |
Bump version to 0.21.0; rework changelog, contributors, and docs
Release:
- Bump version to 0.21.0 and regenerate tusb_option.h, library.json,
repository.yml, sonar-project.properties, boards.rst, dependencies.rst
- Add 0.21.0 release notes and split the changelog into per-release files
under docs/info/changelog/ (date out of title, driver/class groups as
sub-headings, DCD & HCD section after Device/Host stacks)
Contributors:
- Credit each release's PR authors in a Contributors section
- Drop the curated contributors page; add MAINTAINERS.rst
Docs:
- Update Code of Conduct to Contributor Covenant 3.0 (keep it in the repo,
remove it from the built docs)
- Sidebar: add a home entry, rename the group to "Documentation", move
Changelog into it, add a GitHub Sponsor button, merge external links,
rename FAQ; hide the inline toctree on the landing page
- Add the make-release skill and update the AGENTS.md release process
Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
Diffstat (limited to 'AGENTS.md')
| -rw-r--r-- | AGENTS.md | 9 |
1 files changed, 6 insertions, 3 deletions
@@ -195,14 +195,17 @@ 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 `docs/info/changelog.rst`: - - `git log <last-tag>..HEAD --oneline` for commit list. +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 + `======` underline, italic date, sections (General, API Changes, DCD & HCD, Device Stack, Host Stack, Testing), RST inline code for symbols. + - 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. |
