Skip to content

Latest commit

 

History

History
57 lines (32 loc) · 3.78 KB

RELEASE.md

File metadata and controls

57 lines (32 loc) · 3.78 KB

IBM PowerVS Block CSI Driver Release Process

Choose the release version and release branch

  1. Find the latest release. For example, v3.5.0.
  2. Increment the version according to semantic versioning https://semver.org/. For example, v3.5.1 for bug fixes or updated images, v3.6.0 for minor changes, v4.0.0 for major changes.
  3. Find or create the corresponding release branch that corresponds to a minor version. For example, for v3.5.1, the release branch would be release-3.5 and it would already exist. For v3.6.0, it would be release-3.6 and the branch needs to be created. If you do not have permission to create the branch, ask the OWNERS.

Create the release commit

Checkout the release branch you chose above, for example, git checkout release-3.5.

Update README.md

  1. Search for any references to the previous version on the README and update them if necessary.
  2. Update the CSI Specification Compatibility Matrix section with the new version.

Update kustomization.yaml

  1. Edit the driver version in kustomization.yaml with the release version.
  2. Update any side car versions if required.

Send a release PR to the release branch

At this point, you should have all the changes required for the release commit. Verify the changes via git diff and send a new PR with the commit against the release branch.

Tag the release

Once the PR is merged, tag the release commit with the release tag. You can do this locally to push the tag or use GitHub to create the release tag. You'll need push privileges for this step.

Promote the new image on registry.k8s.io

  1. Once you create a release, the new image will appear at the Google Artifact Registry.
  2. Click on the release image and capture the Digest from the overview tab. For example, sha256:e9a1de089253f137c19d7414ac17c99ff7cc508473a8f12e0910c580dcc70a57.
  3. Create a PR to add the new release version with the above image digest to the registry.k8s.io/images/k8s-staging-cloud-provider-ibm/images.yaml file.
  4. Once the PR is merged, verify that the new image is listed at the registry.k8s.io Container Registry.

Create the post-release commit

Checkout the main branch git checkout main.

Update README.md

  1. Update the CSI Specification Compatibility Matrix section with the new version.

Update kustomization.yaml

  1. Edit the driver version in kustomization.yaml with the new release version.
  2. Update any side car versions if required.

Send a post-release PR to the main branch

Create a new PR with the commit against the main branch.

The README and kustomize deployment files must not be updated to refer to the new image until the image has been verified and is available. It is necessary to make these changes in a post-release PR rather than the original release PR.