Release Process

Requirements

1. No warnings emitted when built
2. Consistent formatting - Enforced by CI
3. No valgrind errors - Enforced by CI

Process

1. Update version.txt with new version number (Check for any other places in the repo that may reference the version number)
2. Commit and push the version number update and PR to master branch
3. Use GitHub UI to draft a new release
   • Input the version number in version.txt into the Tag version field
   • Doing it this way ensures there is a single linear history of releases
   • To generate the All Changes list: git log --pretty=%s <last_release_tag>..HEAD

Python

See here

Homebrew

See sample PR https://github.com/Homebrew/homebrew-core/pull/72409

Java

See here

C#

TODO

Docker image

https://github.com/vowpalwabbit/docker-images#release-steps