diff --git a/docs/release.md b/docs/release.md new file mode 100644 index 0000000..fb672a2 --- /dev/null +++ b/docs/release.md @@ -0,0 +1,24 @@ +# Release process/changelog + +The project follows a slightly modified version of [semantic versioning](https://semver.org/spec/v2.0.0.html). The SDK is still evolving and certain backwards-incompatible changes may be released as minor versions. + +## Minor versions + +We will increase minor versions for **breaking changes** to any public interfaces. For example, going from `1.0.x` to `1.1.x` might include breaking changes. + +If you don't want breaking changes, we recommend pinning to `1.0.x` versions in your project. + +## Patch versions + +We will increment patch versions for non-breaking changes: + +- Bug fixes +- New features +- Changes to private interfaces + +## Breaking change changelog + +### 1.1.0 + +- `CustomSummary`, `CustomTask`, and `EntitySource` types have been updated to restrict `icon` to `IconName`. +- All `ThreadItemConverter` methods have been updated to be asynchronous. diff --git a/mkdocs.yml b/mkdocs.yml index 382075c..6e0c7e3 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -53,6 +53,7 @@ nav: - store: api/chatkit/store.md - types: api/chatkit/types.md - widgets: api/chatkit/widgets.md + - Release process / changelog: release.md - ChatKit JS Docs: https://openai.github.io/chatkit-js/ markdown_extensions: - pymdownx.superfences: @@ -76,4 +77,4 @@ extra_css: - stylesheets/extra.css watch: - - chatkit \ No newline at end of file + - chatkit diff --git a/pyproject.toml b/pyproject.toml index d38329e..280dce9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "openai-chatkit" -version = "1.0.3" +version = "1.1.0" description = "A ChatKit backend SDK." readme = "README.md" requires-python = ">=3.10" diff --git a/uv.lock b/uv.lock index d387eca..017d92b 100644 --- a/uv.lock +++ b/uv.lock @@ -819,7 +819,7 @@ wheels = [ [[package]] name = "openai-chatkit" -version = "1.0.3" +version = "1.1.0" source = { virtual = "." } dependencies = [ { name = "openai" },