openai/chatkit-python
Publicmirrored fromhttps://github.com/openai/chatkit-pythonAvailable
docs/release.md
24lines · modecode
| 1 | # Release process/changelog |
| 2 | |
| 3 | 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. |
| 4 | |
| 5 | ## Minor versions |
| 6 | |
| 7 | 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. |
| 8 | |
| 9 | If you don't want breaking changes, we recommend pinning to `1.0.x` versions in your project. |
| 10 | |
| 11 | ## Patch versions |
| 12 | |
| 13 | We will increment patch versions for non-breaking changes: |
| 14 | |
| 15 | - Bug fixes |
| 16 | - New features |
| 17 | - Changes to private interfaces |
| 18 | |
| 19 | ## Breaking change changelog |
| 20 | |
| 21 | ### 1.1.0 |
| 22 | |
| 23 | - `CustomSummary`, `CustomTask`, and `EntitySource` types have been updated to restrict `icon` to `IconName`. |
| 24 | - All `ThreadItemConverter` methods have been updated to be asynchronous. |
| 25 | |