Release Checklist

This checklist will prepare v1.3.0 from v1.2.0. Adjust your version numbers accordingly.

Merge ready PRs

Create docs release (new major or minor release)

cd docs
npm install
npm run docusaurus docs:version 1.3
# push upstream via PR

On the CoreOS config repo, create two new branches release/v1.3, stream/v1.3 (new minor version) or use the existing ones (new patch version). The release branch contains the squashed changeset and is branched from main while the stream branch contains the rebased changesets on top of the latest upstream changes. Consult this guide on rebasing forks (INTERNAL) on how to create those two branches.
Create a new branch release/v1.3 (new minor version) or use the existing one (new patch version)

On this branch, prepare the following things:

(new patch version) cherry-pick (only) the required commits from main

Use Build micro-service manual and run the pipeline once for each micro-service with the following parameters:

branch: release/v1.3
Container image tag: v1.3.0
Version of the image to build: 1.3.0

ver=1.3.0

minor=$(echo $ver | cut -d '.' -f 1,2)
gcpVer=$(echo $ver | tr "." "-")
echo $minor # should be 1.3
echo $gcpVer # should be 1-3-0

gh workflow run build-micro-service-manual.yml --ref release/v$minor -F microService=access-manager -F imageTag=v$ver -F version=$ver --repo edgelesssys/constellation
gh workflow run build-micro-service-manual.yml --ref release/v$minor -F microService=join-service -F imageTag=v$ver -F version=$ver --repo edgelesssys/constellation
gh workflow run build-micro-service-manual.yml --ref release/v$minor -F microService=kmsserver -F imageTag=v$ver -F version=$ver --repo edgelesssys/constellation
gh workflow run build-micro-service-manual.yml --ref release/v$minor -F microService=verification-service -F imageTag=v$ver -F version=$ver --repo edgelesssys/constellation

Use Build operator manual and run the pipeline once with the following parameters:

branch: release/v1.3
Container image tag: v1.3.0

# Alternative from CLI
gh workflow run build-operator-manual.yml --ref release/v$minor -F imageTag=v$ver --repo edgelesssys/constellation

Review and update changelog with all changes since last release. GitHub's diff view helps a lot!
1. Rename the "Unreleased" heading to "[v1.3.0] - YYYY-MM-DD" and link the version to the upcoming release tag.
2. Create a new block for unreleased changes
Update project version in CMakeLists.txt to 1.3.0 (without v).
When the microservice builds are finished update versions in versions.go to v1.3.0, add the container hashes and push your changes.

Create a production coreOS image

gh workflow run build-coreos.yml --ref release/v$minor -F debug=false -F coreOSConfigBranch=release/v$minor -F imageVersion=v$ver

Update default images in config

Run manual E2E tests using Linux and macOS to confirm functionality and stability.

sono='--plugin e2e --plugin-env e2e.E2E_FOCUS="\[Conformance\]" --plugin-env e2e.E2E_SKIP="for service with type clusterIP|HostPort validates that there is no conflict between pods with same hostPort but different hostIP and protocol" --plugin https://raw.githubusercontent.com/vmware-tanzu/sonobuoy-plugins/master/cis-benchmarks/kube-bench-plugin.yaml --plugin https://raw.githubusercontent.com/vmware-tanzu/sonobuoy-plugins/master/cis-benchmarks/kube-bench-master-plugin.yaml'
gh workflow run e2e-test-manual.yml --ref release/v$minor -F cloudProvider=azure -F machineType=Standard_DC4as_v5 -F sonobuoyTestSuiteCmd="$sono" -F coreosImage=/CommunityGalleries/ConstellationCVM-b3782fa0-0df7-4f2f-963e-fc7fc42663df/Images/constellation/Versions/$ver -F isDebugImage=false
gh workflow run e2e-test-manual-macos.yml --ref release/v$minor -F cloudProvider=azure -F machineType=Standard_DC4as_v5 -F sonobuoyTestSuiteCmd="$sono" -F coreosImage=/CommunityGalleries/ConstellationCVM-b3782fa0-0df7-4f2f-963e-fc7fc42663df/Images/constellation/Versions/$ver -F isDebugImage=false
gh workflow run e2e-test-manual.yml --ref release/v$minor -F cloudProvider=gcp -F machineType=n2d-standard-4 -F sonobuoyTestSuiteCmd="$sono" -F coreosImage=projects/constellation-images/global/images/constellation-v$gcpVer -F isDebugImage=false
gh workflow run e2e-test-manual-macos.yml --ref release/v$minor -F cloudProvider=gcp -F machineType=n2d-standard-4 -F sonobuoyTestSuiteCmd="$sono" -F coreosImage=projects/constellation-images/global/images/constellation-v$gcpVer -F isDebugImage=false

Generate measurements for the images on each CSP.

   gh workflow run generate-measurements.yml --ref release/v$minor -F cloudProvider=azure -F coreosImage=/CommunityGalleries/ConstellationCVM-b3782fa0-0df7-4f2f-963e-fc7fc42663df/Images/constellation/Versions/$ver -F isDebugImage=false
   gh workflow run generate-measurements.yml --ref release/v$minor -F cloudProvider=gcp -F coreosImage=projects/constellation-images/global/images/constellation-v$gcpVer -F isDebugImage=false

Create a new tag on this release branch
```
git tag v$ver
git tags --push
```
- Run Release CLI action on the tag
```
gh workflow run release-cli.yml --ref v$ver
```
- The previous step will create a draft release. Check build output for link to draft release. Review & approve.

Follow export flow (INTERNAL) to make image available in S3 for trusted launch users.
To bring updated version numbers and other changes (if any) to main, create a new branch feat/release from release/v1.3, rebase it onto main, and create a PR to main
Milestones management
1. Create a new milestone for the next release
2. Add the next release manager and an approximate release date to the milestone description
3. Close the milestone for the release
4. Move open issues and PRs from closed milestone to next milestone

If the release is a minor version release, create an empty commit on main and tag it as the start of the next pre-release phase.

nextMinorVer=$(echo $ver | awk -F. -v OFS=. '{$2 += 1 ; print}')
git checkout main
git pull
git commit --allow-empty -m "Start v$nextMinorVer-pre"
git tag v$nextMinorVer-pre
git push origin main v$nextMinorVer-pre

7.5 KiB Raw Blame History

Release Checklist

7.5 KiB

Raw Blame History