Skip to content

Latest commit

 

History

History
63 lines (42 loc) · 2.36 KB

RELEASE.md

File metadata and controls

63 lines (42 loc) · 2.36 KB
Raw

Release process for LangStream

Overview

  1. Release the project and trigger the CI pipeline.
  2. Update the HomeBrew formula with the new version.
  3. Update the Helm chart with the new version, if needed.
  4. Update API reference.
  5. Write and publish release notes.

Release the current code and CRDs

mvn release:prepare

After this command:

  • The new docker images will be available
  • A new GitHub release will be created

Update the HomeBrew formula

Update the CLI formulae with the new version tarball url:

  1. Open the file langstream.rb
  2. Insert the new version
  3. Update the sha256 checksum (sha256sum langstream-<version>.zip)

Update the mini-langstream formulae with the new version tarball url:

  1. Open the file mini-langstream.rb
  2. Insert the new version
  3. Update the sha256 checksum (sha256sum mini-langstream-<version>.zip)

Update the Helm chart

This step is optional and recommended only for new stable versions.

  1. Set the new version in the values.yaml file.
  2. Update the CRDs running the following command:
git clone https://github.com/LangStream/charts langstream-charts
cd langstream-charts
./import-langstream-crds.sh <version>
git commit -am "Import new CRDs" && git push origin

CRDs normally doesn't change so this step is not needed for every release but if they do, you must update them the Helm chart. 3. Cut a release chart release. Update the version in the Chart.yaml file and push the change.

Update API reference

Follow instructions to update the API reference.

Release notes

Get the release notes from the GitHub changelog. You can find it here.

From there, you can copy, clean them up and publish them in:

  1. Slack channel #general
  2. Website changelog