backbeat: add module sources
This commit is contained in:
31
decision-records/DR-2025-10-16-module-release.md
Normal file
31
decision-records/DR-2025-10-16-module-release.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# Decision Record: Publish BACKBEAT Go Module v0.1.0
|
||||
|
||||
- **Date:** 2025-10-16
|
||||
- **Status:** Accepted
|
||||
- **UCXL:** ucxl://backbeat:maintainer@BACKBEAT:releases/DRs/2025-10-16-module-release.md
|
||||
|
||||
## Problem
|
||||
|
||||
WHOOSH, CHORUS, and downstream SDK users depended on BACKBEAT via local `replace` directives because no tagged module version existed. This blocked clean dependency management and external consumption.
|
||||
|
||||
## Options
|
||||
|
||||
1. Keep using workspace replacements.
|
||||
2. Fold BACKBEAT into the CHORUS repository.
|
||||
3. Publish an initial semantic version (`v0.1.0`). *(Chosen)*
|
||||
|
||||
## Decision
|
||||
|
||||
Cut release tag `v0.1.0` from `master`, update documentation to advertise the module, and repoint consuming services at the tagged version while removing local overrides.
|
||||
|
||||
## Impact
|
||||
|
||||
- Establishes a canonical module reference for SDK consumers.
|
||||
- Enables removal of `replace` directives in CHORUS/WHOOSH.
|
||||
- No runtime changes; this is a packaging improvement.
|
||||
|
||||
## Follow-Up
|
||||
|
||||
1. Maintain a release checklist for future tags (change log, tests, artifact links).
|
||||
2. Monitor CHORUS/WHOOSH builds to ensure GOPRIVATE/git config allow fetching the module.
|
||||
3. Mirror the module to public hosting if external consumers require open access.
|
||||
Reference in New Issue
Block a user