Skip to content

Latest commit

 

History

History
25 lines (17 loc) · 1.05 KB

File metadata and controls

25 lines (17 loc) · 1.05 KB

Release

This document describes how to release the Tinkerell infrastructure provider.

This is not intended for regular users.

This is normally performed by our CI system. However, there are important steps to take first.

How to Cut a Release

In order to cut a release, you must:

  1. If this is a new major or minor version - but not just a patch change - update metadata.yaml to add it, and map it to the correct cluster-api contract version
  2. Commit the changes.
  3. Push out your branch, open a PR and merge the changes
  4. Wait for the Continuous Integration github action to finish running
  5. Tag the release with `git tag -a vX.Y.z -m "Message"
  6. Push out the tag

How A Release Happens

  • GitHub Actions detects a new tag has been pushed
  • CI builds docker images for each supported architecture as well as a multi-arch manifest, and tags it with the semver tag of the release, e.g. v0.1.0
  • CI creates the release in out/release, the equivalent of make release
  • CI copies the artifacts in out/release/* to the github releases