Skip to content

Commit 7327b5d

Browse files
committed
Add release.md with 1.1.0 changelog
1 parent d6da556 commit 7327b5d

File tree

2 files changed

+26
-1
lines changed

2 files changed

+26
-1
lines changed

docs/release.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
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 `_to_input` methods on `ThreadItemConverter` have been updated to be asynchronous.

mkdocs.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ nav:
5353
- store: api/chatkit/store.md
5454
- types: api/chatkit/types.md
5555
- widgets: api/chatkit/widgets.md
56+
- Release process / changelog: release.md
5657
- ChatKit JS Docs: https://openai.github.io/chatkit-js/
5758
markdown_extensions:
5859
- pymdownx.superfences:
@@ -76,4 +77,4 @@ extra_css:
7677
- stylesheets/extra.css
7778

7879
watch:
79-
- chatkit
80+
- chatkit

0 commit comments

Comments
 (0)