ceph-csi/docs/releases.md

Ceph CSI driver Release Process

• Ceph CSI driver Release Process
  • Introduction
  • Versioning
  • Tagging repositories
  • Release process [TBD]

Introduction

This document provides details about Ceph CSI driver release process.

Versioning

The Ceph CSI driver project uses semantic versioning for all releases. Semantic versions are comprised of three fields in the form:

MAJOR.MINOR.PATCH

For examples: 1.0.0, 1.0.0-rc.2.

Semantic versioning is used since the version number is able to convey clear information about how a new version relates to the previous version. For example, semantic versioning can also provide assurances to allow users to know when they must upgrade compared with when they might want to upgrade:

• When PATCH increases, the new release contains important security fixes, general bug fixes and an upgrade is recommended.

The patch field can contain extra details after the number. Dashes denote pre-release versions.1.0.0-rc.2 in the example denotes the second release candidate for release 1.0.0.

• When MINOR increases, the new release adds new features and it must be backward compatible.

• When MAJOR increases, the new release adds new features, bug fixes, or both and which changes the behavior from the previous release (maybe backward incompatible).

Tagging repositories

The tag name must begin with "v" followed by the version number, conforming to the versioning requirements (e.g. a tag of v1.0.0-rc2 for version 1.0.0-rc2). This tag format is used by the GitHub action infrastructure to properly upload and tag releases to Quay.

Release process [TBD]

The Release Owner must follow the following process, which is designed to ensure clarity, quality, stability, and auditability of each release:

• Create a new milestone to track the progress of the release. Set the scheduled date for the release, or update it later when a date is selected.

• Raise new issue in this repository to track the progress of the release with maximum visibility. Link the issue with the milestone for the release.

• Paste the release checklist into the issue.

  This is useful for tracking so that the stage of the release is visible to all interested parties. This checklist could be a list of issues/PRs tracked for a release. The issues/PRs will be marked with the milestone for the release. For example, a milestone called release-2.1.0 (for release version 2.1.0) can be linked to issues and PRs for better tracking release items.

• Once all steps are complete, close the issue and the milestone.