Add VERSIONING.md — SDK and CLI versioning policy#2
Open
pimfeltkamp wants to merge 4 commits intomainfrom
Open
Add VERSIONING.md — SDK and CLI versioning policy#2pimfeltkamp wants to merge 4 commits intomainfrom
pimfeltkamp wants to merge 4 commits intomainfrom
Conversation
Covers SemVer rules, pre-release naming per ecosystem, tag prefix conventions, tag/manifest parity checks, deprecation policy, security release fast-track, and the independence between SDK versions and the public /v1 API. Each SDK repo's README will link here as the single source of truth. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The PHP SDK ships as cryptohopper/sdk on Packagist. It uses bare v* tags (like the Go SDK) because Packagist reads Git tags directly as SemVer and rejects prefixed tags such as php-v0.1.0-alpha.1. Also documents the Packagist auth model (none in-repo — a GitHub webhook pings Packagist, which pulls the tag itself). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Dart joins Go and PHP as the third SDK that publishes from bare v* tags, because pub.dev (like the Go module proxy and Packagist) reads tags directly as the SemVer version and rejects prefixed names. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Swift joins the bare-v*-tag group (Go, PHP, Dart, Swift) since SwiftPM resolves dependency versions from the git tag, same way Go's module proxy and pub.dev work. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
4 tasks
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
1 participant
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
VERSIONING.mdat the repo root as the single source of truth for how the official SDKs and CLI are versioned, released, and deprecated.openapi/andVERSIONING.md.What it covers
codeenum, runtime floors are in;_internal, log text, transitive deps are out).0.3.0-alpha.1for npm/Go/Ruby/Rust,0.3.0a1for PyPI).sdk-v*,py-v*, barev*for Go,rb-v*,rs-v*,cli-v*) and the tag↔manifest parity check that's already landed in every release workflow./v1API — upgrading an SDK major does not imply a server-side break.Each SDK repo's README will link here so the policy lives in one place.
Test plan
## Versioninglink pointing at this doc