Skip to content

Commit 5c7c678

Browse files
authored
Add release documentation (#814)
## Summary - describe semantic versioning and release steps - add release page to documentation nav ## Testing - `make format` - `make lint` - `make mypy` - `make tests` - `make build-docs` ------ https://chatgpt.com/codex/tasks/task_i_68409d25afdc83218ad362d10c8a80a1
1 parent 05db7a6 commit 5c7c678

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

docs/release.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Release process
2+
3+
The project follows a slightly modified version of semantic versioning using the form `0.Y.Z`. The leading `0` indicates the SDK is still evolving rapidly. Increment the components as follows:
4+
5+
## Minor (`Y`) versions
6+
7+
We will increase minor versions `Y` for **breaking changes** to any public interfaces that are not marked as beta. For example, going from `0.0.x` to `0.1.x` might include breaking changes.
8+
9+
If you don't want breaking changes, we recommend pinning to `0.0.x` versions in your project.
10+
11+
## Patch (`Z`) versions
12+
13+
We will increment `Z` for non-breaking changes:
14+
15+
- Bug fixes
16+
- New features
17+
- Changes to private interfaces
18+
- Updates to beta features

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ plugins:
7272
- models/litellm.md
7373
- config.md
7474
- visualization.md
75+
- release.md
7576
- Voice agents:
7677
- voice/quickstart.md
7778
- voice/pipeline.md

0 commit comments

Comments
 (0)