Skip to content

Latest commit

 

History

History
21 lines (15 loc) · 1.19 KB

RELEASING.md

File metadata and controls

21 lines (15 loc) · 1.19 KB

Releasing New Finch Versions

The Finch release process is largely automated, however there are a few things you need to do to ensure a successful release. See Publishing a release for instructions.

Publishing a release

Create and push a new tag

Depending on your scenario, see Patch release or Major and minor releases for the appropriate steps.

Major and minor releases

  1. Major and minor releases should be branched off of main.
  2. Run make publish NEW_VERSION (replacing NEW_VERSION with the intended value).
  3. Increment the version for the main branch.

Patch release

  1. Patch releases should be branched off the most recent tag: git checkout -b releases/NEW_VERSION TAG (replacing NEW_VERSION and TAG with the intended values).
  2. Apply the necessary changes to the release branch, cherry picking from main as appropriate.
  3. Run make publish NEW_VERSION (replacing NEW_VERSION with the intended value).

Sit back and relax

Pushing a new tag will kick of CI processes which manage the remainder of the release process. Sit back and relax (and confirm the CI operations finish successfully)...