Skip to content

Latest commit

 

History

History
91 lines (68 loc) · 3.02 KB

release.md

File metadata and controls

91 lines (68 loc) · 3.02 KB
Raw

The goal of this document is to define the release process of KubeVirt, but it is not intended to define any release criteria.

Overview

  • KubeVirt uses semantic versioning
  • Primary artifact is the source tree in form of a signed tap using git evtag
  • Binary artifacts are built using automation
  • The releases appear on a time based release schedule

Content

The primary artifact of a release is the source tree itself. The trust on the tree is established by using git-evtag which can be used to sign the tree recursively, including blobs and submodules.

For convenience a number of binary artifacts can be provided alongside a release, those are:

  • Container images (currently docker images), tagged and pushed to a registry
  • Client side binaries (i.e. virtctl), published on the release page

These artifacts are provided in their respective channels and their natural way of distribution.

Cadence

A release will take place on the first Monday of each month. The release owner is in charge of delaying a release if it is really necessary. If a release has to be delayed by more than a week, then the release must be skipped.

Versioning

The release owner is in charge of choosing the correct release version - according to the semantic versioning conventions.

The determined version is then prefixed with a v (mostly for consistency, because we started this way) and used as the tag name ($TAG below).

Examples:

v0.0.1-alpha.0
v0.0.1-alpha.1

Release notes

Every release must should be accompanied by release notes describing the major highlights of the release. The release notes must be provided in the commit message of the tag.

Announcement

Every release must be announced on the kubevirt-dev mailinglist kubevirt-dev@googlegroups.com.

The hack/release-announce.sh script should be used to generate the announce email. Using this script ensures consistency and documentation of the release process and content between releases.

Releasing

The release process is mostly automatic and consists of the following steps:

  1. Run the hack/release-announce.sh script which runs functional tests, generates some stats and outputs the announce text.
  2. Tag the commit using git evtag sign $TAG (which is a signed and annotated tag)
    1. Provide the announce text as part of the tag commit message
  3. Push the tag to github git push git@github.com:kubevirt/kubevirt.git $TAG
  4. Wait for travis to finish, and check that the binary artifacts got attached to the release at https://github.com/kubevirt/kubevirt/releases/tag/$TAG and that the containers were correctly tagged and pushed to https://hub.docker.com/r/kubevirt/
  5. Adjust the release details (draft, pre-release) as necessary at https://github.com/kubevirt/kubevirt/releases/tag/$TAG
  6. Sent a friendly announcement email to kubevirt-dev@googlegroups.com