diff --git a/docs/adr/0001-releasekit.md b/docs/adr/0001-releasekit.md new file mode 100644 index 0000000..33bc8b0 --- /dev/null +++ b/docs/adr/0001-releasekit.md @@ -0,0 +1,45 @@ +# ADR 0001: Adopt ReleaseKit for release management + +## Status + +Accepted. + +## Date + +2026-10-07 + +## Context + +Audita maintains custom release scripts, build tooling, delivery configuration, +and tests for mechanics shared across applications in the same suite. +[ReleaseKit](https://gitea.maximumdirect.net/eric/ReleaseKit) provides a common implementation and standard workflow for +those responsibilities. + +## Decision + +Adopt ReleaseKit for shared release validation, source publication, binary +builds, version information, and hosted delivery. Audita will follow its standard +workflow and supply product identity, delivery targets, release notes, and +necessary product-specific checks. + +Better maintainability and less locally owned release-focused code outweigh any +small advantage from retaining Audita's custom release procedure. Changes to +that procedure are an accepted consequence of standardization. + +## Alternatives considered + +Retaining the custom procedure would preserve its exact behavior and local +control. It would also retain responsibility for duplicated mechanics, tests, +and maintenance across projects. The shared implementation offers greater +long-term value. + +## Consequences + +Audita's release integration becomes smaller, with common mechanics and their +tests maintained upstream. Audita benefits from shared fixes and takes on +ReleaseKit dependency maintenance. + +Adoption requires updates to release tooling, CI wiring, documentation, and +runtime version reporting. The [release policy](../policy/release.md) continues +to govern compatibility and release completion; the +[release procedure](../release.md) will describe the adopted workflow.