Skip to content

Commit 5055f2b

Browse files
committed
docs: document the release procedure, including the GitHub Release step
1 parent c335b2b commit 5055f2b

1 file changed

Lines changed: 15 additions & 2 deletions

File tree

CONTRIBUTING.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,21 @@ pull request.
8181

8282
## Releasing
8383

84-
Push a `v*` tag (for example `v1.0.0`); the `Release AAR` workflow builds the
85-
`.aar` and attaches it to the corresponding GitHub release.
84+
Publishing is automated from a signed `v*` tag; still give the **GitHub Release
85+
a proper description — don't skip it.** The full checklist:
86+
87+
1. Bump `version` in [`cobs/build.gradle.kts`](cobs/build.gradle.kts) and add a
88+
`## X.Y.Z` section to [`CHANGELOG.md`](CHANGELOG.md).
89+
2. Commit (`chore: release X.Y.Z`) and tag it **signed**:
90+
`git tag -s vX.Y.Z -m "cobs_codec X.Y.Z"`; push `main` and the tag.
91+
3. The tag triggers two workflows:
92+
[`publish-maven.yml`](.github/workflows/publish-maven.yml) publishes
93+
`dev.firechip:cobs_codec` to **GitHub Packages** (Maven), and
94+
[`release-aar.yml`](.github/workflows/release-aar.yml) builds the `.aar` and
95+
attaches it to the **GitHub Release** it creates for the tag.
96+
4. Edit that release's description to match the other members: the
97+
`CHANGELOG.md` highlights, the `dev.firechip:cobs_codec:X.Y.Z` Maven
98+
coordinate, and the attached `.aar`.
8699

87100
## License
88101

0 commit comments

Comments
 (0)