Skip to content

Commit 250503f

Browse files
committed
docs: document the release procedure, including the GitHub Release step
1 parent 59c1b0f commit 250503f

1 file changed

Lines changed: 16 additions & 2 deletions

File tree

CONTRIBUTING.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,5 +39,19 @@ The macOS build is validated in CI on a macOS runner.
3939
## Releases
4040

4141
Releases follow [Semantic Versioning](https://semver.org). Swift Package Manager
42-
resolves versions from Git tags, so a release is a signed `vX.Y.Z` tag pushed to
43-
`main` (plus a `CHANGELOG.md` entry).
42+
resolves versions from Git tags, so there is no registry publish step — but the
43+
**GitHub Release is still created by hand; don't skip it.**
44+
45+
1. Add a `## X.Y.Z` section to [`CHANGELOG.md`](CHANGELOG.md).
46+
2. Commit and tag it **signed**: `git tag -s vX.Y.Z -m "CobsCodec X.Y.Z"`; push
47+
`main` and the tag. SwiftPM and the Swift Package Index pick it up from the tag.
48+
3. Create the **GitHub Release** for the tag with a description that matches the
49+
other members — the `CHANGELOG.md` highlights, the SwiftPM install snippet,
50+
and the [Swift Package Index](https://swiftpackageindex.com/firechip/cobs_codec_swift)
51+
link. GitHub attaches the source archives automatically; there is no build
52+
artifact to upload.
53+
54+
```console
55+
gh release create vX.Y.Z --verify-tag --title "CobsCodec X.Y.Z" \
56+
--notes-file notes.md
57+
```

0 commit comments

Comments
 (0)