Skip to content

Commit

Permalink
Release prep 1.2.0 (#1344)
Browse files Browse the repository at this point in the history
* Changelog for 1.2.0

* Amend release engineering instructions.

* Bump package version number.
  • Loading branch information
dokterbob authored Sep 16, 2024
1 parent e235a34 commit 052e8d8
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 10 deletions.
39 changes: 39 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,45 @@ All notable changes to Chainlit will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

## [1.2.0] - 2024-09-16

### Security

- Fixed critical vulnerabilities allowing arbitrary file read access (#1326)
- Improved path traversal protection in various endpoints (#1326)

### Added

- Hebrew translation JSON (#1322)
- Translation files for Indian languages (#1321)
- Support for displaying function calls as tools in Chain of Thought for LlamaIndexCallbackHandler (#1285)
- Improved feedback UI with refined type handling (#1325)

### Changed

- Upgraded cryptography from 43.0.0 to 43.0.1 in backend dependencies (#1298)
- Improved GitHub Actions workflow (#1301)
- Enhanced data layer cleanup for better performance (#1288)
- Factored out callbacks with extensive test coverage (#1292)
- Adopted strict adherence to Semantic Versioning (SemVer)

### Fixed

- Websocket connection issues when submounting Chainlit (#1337)
- Show_input functionality on chat resume for SQLAlchemy (#1221)
- Negative feedback class incorrectness (#1332)
- Interaction issues with Chat Profile Description Popover (#1276)
- Centered steps within assistant messages (#1324)
- Minor spelling errors (#1341)

### Development

- Added documentation for release engineering process (#1293)
- Implemented testing for FastAPI version matrix (#1306)
- Removed wait statements from E2E tests for improved performance (#1270)
- Bumped dataclasses to latest version (#1291)
- Ensured environment loading before other imports (#1328)

## [1.1.404] - 2024-09-04

### Security
Expand Down
22 changes: 13 additions & 9 deletions RELENG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,23 @@ This document outlines the steps for maintainers to create a new release of the

## Steps

1. **Update the changelog**:

- Create a pull request to update the CHANGELOG.md file with the changes for the new release.
- Mark any breaking changes clearly.
- Get the changelog update PR reviewed and merged.

2. **Determine the new version number**:
1. **Determine the new version number**:

- We use semantic versioning (major.minor.patch).
- Increment the major version for breaking changes, minor version for new features, patch version for bug fixes only.
- If unsure, discuss with the maintainers to determine if it should be a major/minor version bump or new patch version.

3. **Create a new release**:
2. **Bump the package version**:

- Update `version` in `[tool.poetry]` of `backend/pyproject.toml`.

3. **Update the changelog**:

- Create a pull request to update the CHANGELOG.md file with the changes for the new release.
- Mark any breaking changes clearly.
- Get the changelog update PR reviewed and merged.

4. **Create a new release**:

- In the GitHub repo, go to the "Releases" page and click "Draft a new release".
- Input the new version number as the tag (e.g. 4.0.4).
Expand All @@ -29,7 +33,7 @@ This document outlines the steps for maintainers to create a new release of the
- If this is a full release after an RC, remove any "-rc" suffix from the version number.
- Publish the release.

4. **Update any associated documentation and examples**:
5. **Update any associated documentation and examples**:
- If needed, create PRs to update the version referenced in the docs and example code to match the newly released version.
- Especially important for documented breaking changes.

Expand Down
2 changes: 1 addition & 1 deletion backend/pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "chainlit"
version = "1.1.404"
version = "1.2.0"
keywords = [
'LLM',
'Agents',
Expand Down

0 comments on commit 052e8d8

Please sign in to comment.