docs: formalize the deferred-otel decision for v1 - #31
Merged
Conversation
Record the decision agreed during the v1 planning: otel (and the other runtime dependencies whose types hexa re-exports — mongo-driver, zap, go-i18n) stay at their currently pinned versions for v1. Modernizing them lands in v2 (the /v2 module path) alongside the other breaking work. - CHANGELOG.md: convert the Compatibility section to bullets, add the runtime-dependency-pinning rationale, and fix the now-inaccurate "no signatures changed" claim (LevelFromString's signature changed in #28 to return (Level, error) instead of panicking). - docs/v1-release-plan.md: mark Phase 2's "Modernize dependencies" item decided/deferred, and narrow Phase 3's Observability bullet to "verify on the pinned otel versions; migration is v2." https://claude.ai/code/session_01J46cm6MaKsVpw1YSXGg8eq
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Records the decision agreed during v1 planning: runtime dependencies stay pinned for v1; modernization (notably otel) lands in v2. Docs-only, no code changes.
CHANGELOG.md— convert the Compatibility section to bullets and add the rationale:otel,mongo-driver,zap,go-i18n. otel is hard-breaking becausehtelexposesmetric.MeterProviderand otel'smetricpackage had a v0.x→v1.x redesign; the trace/sdk modules are coupled to it. Modernization is scheduled for v2 (github.com/kamva/hexa/v2).hlog.LevelFromStringdid change in fix: registry mutex, LevelFromString error, hurl status threshold #28 to return(Level, error)instead of panicking on unknown input.docs/v1-release-plan.md— Phase 2's "Modernize dependencies" item is now marked decided/deferred to v2; Phase 3's Observability bullet is narrowed to "verify on the pinned otel versions; migration is v2."Notes
#15,#16–#25,#26–#28). That broader backfill is out of scope here — let me know if you'd like a follow-up to bring the whole thing current before tagging v1.🤖 Generated with Claude Code
Generated by Claude Code