cognee/.github/docs/release.md
2026-01-20 15:42:54 +01:00

1.4 KiB

How to make a release

Dev release

Prepare release

  1. Set the project version that will be released in pyproject.toml
  2. Update uv.lock with uv lock lock command
  3. Create a PR with the changes mentioned above to dev and merge it.

Perform Release

  1. Go to Release action
  2. Select dev branch and run the workflow.
  3. Watch the logs and make sure that everything goes well

Main release

Prepare release

  1. Set the project version that will be released in pyproject.toml
  2. Update uv.lock with uv lock lock command
  3. Create a PR with the changes mentioned above to dev and merge it.

Perform Release

  1. Go to Release action
  2. Select main branch and run the workflow.
  3. Watch the logs and make sure that everything goes well

Release validation

  1. Make sure that the correct image is published to Docker Hub
  2. Python package is published to PyPi
  3. Find the created github release in GitHub releases. Edit/prettify the release notes if required.