docs(architecture): add API Stability section clarifying module semver policy#3422
Merged
dominikschulz merged 1 commit intogopasspw:masterfrom May 4, 2026
Merged
Conversation
…r policy The existing semver note acknowledged the CLI-only versioning decision but gave consumers no actionable guidance. The new section states the current policy explicitly, tells pkg/ consumers how to protect themselves (pin, watch CHANGELOG), and points to the open ADR issue for the longer-term resolution.
dominikschulz
approved these changes
May 4, 2026
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
ARCHITECTURE.mdalready noted that semver applies to the CLI only and called it "not ideal," but gave consumers ofpkg/gopassno actionable guidance on how to protect themselves from silent breaking changes.This PR adds an API Stability section (inserted between the semver note and
### docs/backends) that:pkg/gopass/doc.go's existing instability warning as the canonical signalNo behaviour change. Documentation only.
Test plan
### docs/backends