Skip to content

Commit

Permalink
docs: Updated Changelog for release v0.10.0
Browse files Browse the repository at this point in the history
docs: Changed release instruction to create the tag before the release is deployed

TASK: IL-423
  • Loading branch information
FlorianSchepersAA committed Apr 22, 2024
1 parent 74bfada commit d2de1ee
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 2 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@

## Unreleased

### Breaking Changes

### New Features

### Fixes

## 0.10.0

### Breaking Changes
- breaking change: `ExpandChunksOutput` now returns `ChunkWithStartEndIndices` instead of `TextChunk`
- breaking change: `MultipleChunkRetrieverQa`'s `AnswerSource` now contains `EnrichedChunk` instead of just the `TextChunk`
Expand Down
4 changes: 3 additions & 1 deletion RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@
- Update the "version" field of the project in `pyproject.toml`
- We use [semantic versioning](https://semver.org/)
- Commit the changes and merge to main
- Create a new release tag in GitHub (Tags -> Releases -> Draft a new release) and save it as draft
- Tag the latest commit on main with the new release number (e.g. v0.6.0)
- `git checkout main, git tag <tag_name>, git push origin <tag_name>`
- Create a new release draft in GitHub (Tags -> Releases -> Draft a new release) and save it as draft
- Copy the changelog into the release description. Also add a link to the commits since the last release at the bottom of the description.
- Make sure the changes have been merged into the main branch.
- Publish the release.
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"

[tool.poetry]
name = "intelligence-layer"
version = "0.9.1"
version = "0.10.0"
description = ""
authors = ["Aleph Alpha Engineering <[email protected]>"]
readme = "README.md"
Expand Down

0 comments on commit d2de1ee

Please sign in to comment.