Skip to content

Add release documentation #814

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 4, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
Next Next commit
Add release documentation
  • Loading branch information
rm-openai committed Jun 4, 2025
commit 6f2097d98f5fae62b39c57c0ffb4a98d267fc6de
24 changes: 24 additions & 0 deletions docs/release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Release process

The project follows semantic versioning using the form `0.Y.Z`. The leading `0` indicates the SDK is still evolving rapidly. Increment the components as follows:

## Minor (`Y`) versions

Increase `Y` for **breaking changes** to any public interfaces that are not marked as beta.

## Patch (`Z`) versions

Increment `Z` for:

- Bug fixes
- New features
- Changes to private interfaces
- Updates to beta features

## Steps to cut a release

1. Ensure `main` is stable and all tests pass.
2. Update the version in `pyproject.toml`.
3. Document notable changes in `CHANGELOG.md`.
4. Tag the commit with the version number and push the tag.
5. Publish the release on GitHub and PyPI.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ plugins:
- models/litellm.md
- config.md
- visualization.md
- release.md
- Voice agents:
- voice/quickstart.md
- voice/pipeline.md
Expand Down