Skip to content

Commit 9d52e62

Browse files
committed
Document subpackage release workflow [skip ci]
1 parent 3a2aad0 commit 9d52e62

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,15 @@ julia --project=docs -e 'using DocumenterVitepress; DocumenterVitepress.dev_docs
139139

140140
## Releases
141141
- JuliaRegistrator release notes must explicitly mention breaking status. Include a `## Breaking changes` section, or state `No breaking changes`; AutoMerge requires the words `breaking` or `changelog`.
142+
- For subpackage GitHub releases, create annotated tags at current `origin/master`, not the feature branch. Fetch first, verify the tag does not already exist, then tag and publish sequentially.
143+
- Use the exact tag as the GitHub release title, e.g. `KomaMRIBase-v0.11.0`. Put only the provided release notes in the release body.
144+
- Useful pattern:
145+
```bash
146+
git fetch origin master --tags
147+
git tag -a KomaMRIBase-v0.11.0 -F notes.md origin/master
148+
git push origin KomaMRIBase-v0.11.0
149+
gh release create KomaMRIBase-v0.11.0 --title KomaMRIBase-v0.11.0 --notes-file notes.md
150+
```
142151

143152
## Canonical References
144153
- Contributor workflow: `docs/src/how-to/5-contribute-to-koma.md`

0 commit comments

Comments
 (0)