Release Instructions

Jump to bottom

Nicholas Long edited this page Jun 17, 2022 · 3 revisions

Release dependent projects as needed (e.g., alfalfa-client).
Create a PR with the release prep branch against develop.
Update version in pypoetry.toml and any required dependencies/dependent projects.
Update the change log. It is easiest to use GitHub's "Generate Release Notes" which is accessible on the Draft New Release Page. Add in a tag and target (to the release prep branch), then click on the "Generate Release Notes". Copy the generate content into the CHANGELOG.md. Do NOT release this version though.
Commit changes
After tests pass, merge to develop, then create a PR against main
After the main tests pass, then merge the PR. This will automatically be released to Docker Hub under the following images. It is recommended to verify that these images are updated (which can take up to an hour).
Go back to GitHub and release Alfalfa with the "Generated Release Notes" button.
Celebrate!