docs: add release guide #240

Merged

jorge.bornhausen merged 1 commit from docs/add-release-guide into main

2026-10-16 17:25:07 +00:00

jorge.bornhausen commented

2026-10-16 17:18:53 +00:00

Owner

Adds docs/release.md, a release guide for quarkus-commons, modeled on the kvant-api release guide and adapted to this repository's reality:

Published artifacts are jars of the parent pom and all 13 modules, deployed by the tag Build workflow to the phoenix-oss Maven registry — no container images, no deployments.
The former GitOps/deployment section is replaced with a note that a release is complete once the jars are published; released versions are treated as immutable, broken releases fix forward via a patch.
Documented release:prepare accurately: tests are not skipped here (no -Darguments="-DskipTests"), so the full reactor build runs before tagging.
No cliff.toml in this repository — the changelog section states git-cliff's default configuration is used.
CI reference table reflects this repo's three workflows (no publish-branch workflow; manual dispatch noted on Build).
Conventional-commit guidance references Forgejo issues/PRs rather than Jira; examples (feat(uuid): ... (#239), release/2.10, 2.10.0) are grounded in the actual release history and workflow definitions.

No code changes; documentation only.

Adds `docs/release.md`, a release guide for quarkus-commons, modeled on the kvant-api release guide and adapted to this repository's reality: - **Published artifacts** are jars of the parent pom and all 13 modules, deployed by the tag Build workflow to the phoenix-oss Maven registry — no container images, no deployments. - The former GitOps/deployment section is replaced with a note that a release is complete once the jars are published; released versions are treated as immutable, broken releases fix forward via a patch. - Documented `release:prepare` accurately: tests are **not** skipped here (no `-Darguments="-DskipTests"`), so the full reactor build runs before tagging. - No `cliff.toml` in this repository — the changelog section states git-cliff's default configuration is used. - CI reference table reflects this repo's three workflows (no publish-branch workflow; manual dispatch noted on Build). - Conventional-commit guidance references Forgejo issues/PRs rather than Jira; examples (`feat(uuid): ... (#239)`, `release/2.10`, `2.10.0`) are grounded in the actual release history and workflow definitions. No code changes; documentation only.

jorge.bornhausen added 1 commit

2026-10-16 17:18:54 +00:00

docs: add release guide

Build / build (pull_request) Successful in 3m43s

Details

81076f0766