Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
docs(architecture): add API Stability section clarifying module semve…
…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.
  • Loading branch information
dimension-zero committed May 3, 2026
commit 6e0fc3a231522995eb112f9751ed1941cfafd457
18 changes: 18 additions & 0 deletions ARCHITECTURE.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,24 @@ change in the API require a major version bump even if nothing about the tool
apply semantic versioning only to the CLI tool, not the Go module. This is not
ideal and might change with sufficient active contributors.

## API Stability

Semantic versioning applies to the **gopass CLI binary** only. The Go module
(`github.com/gopasspw/gopass`) does not carry independent semver guarantees:
a breaking change to `pkg/` interfaces may ship without a major-version bump.

`pkg/gopass/doc.go` carries an explicit instability warning for this reason.
Until that warning is removed, consumers of `pkg/gopass` should:

- Pin to a specific commit or tag rather than a `@latest` reference.
- Review the `CHANGELOG.md` `pkg/` entries before upgrading.
- Treat any `pkg/` type or function change as potentially breaking.

The intention is to formalise this contract (via a `v2` module path or a
published compatibility window) once the active contributor base grows
sufficiently to maintain that commitment. See issue #3414 for the open
decision on the API stability ADR.

### `docs/backends`

This folder contains documentation about each of our supported backends. See
Expand Down
Loading