One version for all modules
Every published module is released at once with the same version. Use one version for all kcoap modules in a build: they share internal plumbing, and mixed versions are not supported.
Releases
kcoap 0.1.0, the first release, came out on 6 November 2026, on Maven Central and GitHub Packages. It waited for the API-breaking work of the refactoring plan to land, so that it would not break its users right after.
0.1.0On GitHub
Read live from GitHub when this page loads. Each release opens with the summary of its changelog entry, followed by the merged pull requests.
kcoap 0.1.0 came out on 6 November 2026. Its GitHub Release has the notes, and Get started shows how to add it from Maven Central.
The changelog lists every notable change by release, with a migration note for each breaking change; what changes after 0.1.0 goes under “Unreleased” until the next release.
Release freeze
No v* tag was pushed until thirteen work packages had merged: the ones that change the public API. All thirteen had merged on 6 November 2026, the day of the release:
| Package | What it does | State |
|---|---|---|
| A1 | OSCORE safe persistence and secret hygiene | merged |
| A2 | EDHOC capability-aware negotiation, typed retry, returned sessions | merged |
| A3 | The EDHOC and OSCORE glue on interfaces and the application model | merged |
| A4 | kcoap-crypto as the home of shared crypto blocks | merged |
| A5 | DefaultCryptoBackend as a final adapter | merged |
| W1 | RFC 8323 transport follow-ups | merged |
| B1 | One internal link per peer under the CoAP endpoint | merged |
| B2 | kcoap-coap-message split out of kcoap-coap | merged |
| B3 | The public API of kcoap-coap cleaned up | merged |
| C1 | Build governance: ABI dumps, common-only cores, opt-in markers | merged |
| D1 | Two configuration builders and explicit endpoint classes | merged |
| D2 | A KcoapException root, @Throws and a Swift smoke test | merged |
| C3 | Assembly and documentation: a BOM, a getting-started guide, a platforms guide | merged |
TLS for stream transports (T1), browser interop (I1), a crypto conformance suite (C2), consumer samples (P1) and the rest of the CoAP errors and observability work (B4) merged too, but did not block the release. The freeze in the releasing guide.
Process
A release is a v* tag. The version is the tag without the v; between releases the build holds the next version with -SNAPSHOT.
The whole CI workflow runs again: unit tests on every target, the coverage floor, interop with libcoap and libedhoc, the Apple targets and the API reference. Nothing is published if any of it fails.
A macOS runner builds every module for every target, signs each artifact with the release key 5833 7699 D9CB 8E6F 5EB1 BDFB 4A7E 4910 69FA EAB3, publishes them to GitHub Packages and uploads them to the Central Portal. The maintainer checks that deployment and publishes it to Maven Central by hand, a step that cannot be undone. The releasing guide says how to check a signature.
A GitHub Release whose notes are the version’s summary from the changelog, followed by the merged pull requests. A version with a -, such as 0.2.0-rc1, is marked as a pre-release.
Dokka builds the reference and the workflow deploys it to GitHub Pages, at adihack.github.io/kcoap.
Pushing a v* tag, such as v0.1.0, starts the release workflow. Step 1 runs the whole CI workflow; if any of it fails, nothing is published. Step 2 builds every module for every target on a macOS runner, signs each artifact with the release key, publishes them to GitHub Packages and uploads them to the Central Portal, where the maintainer publishes the deployment to Maven Central by hand. Step 3 creates the GitHub Release, whose notes are the version’s summary from the changelog followed by the merged pull requests. Step 4 deploys the API reference, built by Dokka, to GitHub Pages.
Checklist
The releasing guide’s checklist for the first release, as it stood after the release on 6 November 2026:
main, and the whole CI workflow passed again on the tagged commit.CoapEndpointConfig and CoapClientConfig, deprecated for their builders, are removed (work package P1).dev.kcoap namespace is verified in Maven Central’s portal, through a DNS record on kcoap.dev, since 6 November 2026.kcoap-bom with them, which verifyBomConstraints checks against the published modules; CI builds an Android consumer app against them.kcoap-bom, the js one within a bundle-size budget and in headless Chrome (work package P1); their CI jobs passed for the release.v* tags, and GitHub Pages serves from GitHub Actions.dev.kcoap:<module>:0.1.0 and kcoap-bom are on Maven Central.github-pages environment accepted deployments from main only; once it also allowed v* tags, the job ran again and deployed it.Versioning
Semantic Versioning 2.0.0, one version for every module, and a build that checks the public API on every change.
Every published module is released at once with the same version. Use one version for all kcoap modules in a build: they share internal plumbing, and mixed versions are not supported.
A minor release, such as 0.1.0 to 0.2.0, may break the API; each break is listed in the changelog under “Changed (breaking)” with a migration note. A patch release is fixes only and never breaks the API.
Breaking changes only in a major release, after a deprecation that lasts at least one minor release. A security fix that cannot avoid a break, or a raised minimum, may break in a minor.
The stable API is what the ABI dumps hold. @ExperimentalKcoapApi may change in any minor release; @InternalKcoapApi is not API. Unpublished modules promise nothing.
A deviation from an RFC is a bug, fixed in the next patch or minor. A default that changes the wire, such as turning Q-Block on, changes only in a minor or major release. Suite −24 follows its draft.
Listed under “Security” in the changelog. A behaviour change that removes a vulnerability may ship in a patch release.
| Minimum | Version |
|---|---|
| Android | API level 26 (Android 8.0) |
| Kotlin in a consuming project | 2.3 (kcoap is built with Kotlin 2.4) |
| JVM bytecode and runtime | Java 17 |
| Building kcoap | JDK 17 |
Channels
Every release, under the verified dev.kcoap namespace: dev.kcoap:<module>:<version> from mavenCentral(), with no other repository. 0.1.0
Every release, from https://maven.pkg.github.com/adihack/kcoap. Gradle needs a GitHub token with read:packages to read it, even for a public package. 0.1.0
One per tag: the version’s summary from the changelog, then the merged pull requests. The artifacts are in the Maven repositories, not attached to the release. GitHub Releases.
Every release, at adihack.github.io/kcoap: every public declaration with its KDoc. ./gradlew dokkaGenerate in a clone of kcoap builds it into build/dokka/html. 0.1.0