Files
fastembed/RELEASE.md
George da603b8b7d new: add release instructions (#231)
* new: add release instructions

* review fixes

---------

Co-authored-by: Andrey Vasnetsov <andrey@vasnetsov.com>
2024-05-03 18:30:54 +02:00

804 B

Releasing FastEmbed

This is a guide how to release fastembed and fastembed-gpu packages.

How to

  1. Accumulate changes in the main branch.

  2. Bump the version in pyproject.toml

  3. Rebase the gpu branch on main and resolve conflicts if occurred:

git checkout gpu
git rebase main
git push origin gpu
  1. Draft release notes
  2. Checkout to main and create a tag, e.g.:
git checkout main
git tag -a v0.1.0 -m "Release v0.1.0"
  1. Checkout gpu and create a tag, e.g.:
git checkout gpu
git tag -a v0.1.0-gpu -m "Release v0.1.0"
  1. Push tags:
git push --tags
  1. Verify that both packages have been published successfully on PyPI. Try installing them and verify imports.
  2. Create a release on GitHub with the written release notes.