docs(#1): Document release vs dev versioning scheme
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
- Add Versioning section to README with version format table and cross-SDK alignment note (Python PEP 440 vs JS semver) - Add Versioning section to integration guide with install commands for stable and dev builds, pinning examples, and SDK format comparison - Update API reference header to reflect dev version format Refs #1 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
13
README.md
13
README.md
@@ -197,6 +197,19 @@ config = TelemetryConfig(
|
||||
)
|
||||
```
|
||||
|
||||
## Versioning
|
||||
|
||||
This SDK publishes two types of versions to the Mosaic Stack PyPI registry:
|
||||
|
||||
| Channel | Version Format | Example | Branch | Install |
|
||||
|---------|---------------|---------|--------|---------|
|
||||
| **Stable** | `X.Y.Z` | `0.1.0` | `main` / tags | `pip install mosaicstack-telemetry` |
|
||||
| **Dev** | `X.Y.Z.devYYYYMMDDHHMMSS` | `0.1.0.dev20260215045901` | `develop` | `pip install mosaicstack-telemetry --pre` |
|
||||
|
||||
Dev versions use a UTC timestamp suffix (PEP 440 format). This aligns with the JS client SDK which uses the equivalent semver format `X.Y.Z-dev.YYYYMMDDHHmmss`.
|
||||
|
||||
By default, `pip install` resolves only stable releases. Pass `--pre` to include dev versions.
|
||||
|
||||
## Documentation
|
||||
|
||||
- **[Integration Guide](docs/integration-guide.md)** -- Installation, configuration, FastAPI and generic Python examples, async vs sync patterns, prediction queries, error handling
|
||||
|
||||
Reference in New Issue
Block a user