Release process

Release process

For Feast maintainers, these are the concrete steps for making a new release.

1. For new major or minor release, create and check out the release branch for the new stream, e.g. v0.6-branch. For a patch version, check out the stream's release branch.

2. Update the . See the guide and commit

   • Make to review each PR in the changelog to

3. Update versions for the release/release candidate with a commit:

   1. In the root pom.xml, remove -SNAPSHOT from the <revision> property, update versions, and commit.

4. Push the commits and tags. Make sure the CI passes.

   • If the CI does not pass, or if there are new patches for the release fix, repeat step 2 & 3 with release candidates until stable release is achieved.

5. Bump to the next patch version in the release branch, append -SNAPSHOT in pom.xml and push.

6. Create a PR against master to:

   1. Bump to the next major/minor version and append -SNAPSHOT .

   2. Add the change log by applying the change log commit created in step 2.
7. Create a which includes a summary of important changes as well as any artifacts associated with the release. Make sure to include the same change log as added in . Use Feast vX.Y.Z as the title.

When a tag that matches a Semantic Version string is pushed, CI will automatically build and push the relevant artifacts to their repositories or package managers (docker images, Python wheels, etc). JVM artifacts are promoted from Sonatype OSSRH to Maven Central, but it sometimes takes some time for them to be available. The sdk/go/v tag is required to version the Go SDK go module so that users can go get a specific tagged release of the Go SDK.

Creating a change log

We use an to generate change logs. The process still requires a little bit of manual effort.

1. Create a GitHub token as . The token is used as an input argument (-t) to the change log generator.

2. The change log generator configuration below will look for unreleased changes on a specific branch. The branch will be master for a major/minor release, or a release branch (v0.4-branch) for a patch release. You will need to set the branch using the --release-branch argument.

1. Review each change log item.

   • Make sure that sentences are grammatically correct and well formatted (although we will try to enforce this at the PR review stage).

   • Make sure that each item is categorised correctly. You will see the following categories: Breaking changes, Implemented enhancements

Flag Breaking Changes & Deprecations

It's important to flag breaking changes and deprecation to the API for each release so that we can maintain API compatibility.

Developers should have flagged PRs with breaking changes with the compat/breaking label. However, it's important to double check each PR's release notes and contents for changes that will break API compatibility and manually label compat/breaking to PRs with undeclared breaking changes. The change log will have to be regenerated if any new labels have to be added.