constellation/.github/docs/release.md

Release Checklist

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

1. Merge ready PRs
2. Create a new branch release/v1.3.0 to prepare the following things:
   1. Use Build micro-service manual and run the pipeline once for each micro-service with the following parameters:
      • branch: release/v1.3.0
      • Container image tag: v1.3.0
      • Version of the image to build: 1.3.0

      # Alternative from CLI
      gh workflow run build-micro-service-manual.yml --ref release/v1.3.0 -F microService=access-manager -F imageTag=v1.3.0 -F version=1.3.0
      gh workflow run build-micro-service-manual.yml --ref release/v1.3.0 -F microService=join-service -F imageTag=v1.3.0 -F version=1.3.0
      gh workflow run build-micro-service-manual.yml --ref release/v1.3.0 -F microService=kmsserver -F imageTag=v1.3.0 -F version=1.3.0
      gh workflow run build-micro-service-manual.yml --ref release/v1.3.0 -F microService=verification-service -F imageTag=v1.3.0 -F version=1.3.0
      

   2. Use Build operator manual and run the pipeline once with the following parameters:
      • branch: release/v1.3.0
      • Container image tag: v1.3.0

      # Alternative from CLI
      gh workflow run build-operator-manual.yml --ref release/v1.3.0 -F imageTag=v1.3.0
      

   3. Review and update changelog with all changes since last release. GitHub's diff view helps a lot!
   4. Update versions versions.go to v1.3.0 and push your changes.
   5. Create a production coreOS image

      gh workflow run build-coreos.yml --ref release/v1.3.0 -F debug=false -F coreOSConfigBranch=constellation
      

   6. Update default images in config
   7. Merge this branch back to main
3. Run E2E to confirm stability and generate measurements

   gh workflow run e2e-test-manual.yml --ref main -F workerNodesCount=2 -F controlNodesCount=1 -F autoscale=false -F cloudProvider=azure -F machineType=Standard_DC4as_v5 -F sonobuoyTestSuiteCmd="--mode quick" -F kubernetesVersion=1.23 -F coreosImage=/CommunityGalleries/ConstellationCVM-b3782fa0-0df7-4f2f-963e-fc7fc42663df/Images/constellation/Versions/1.3.0 -F isDebugImage=false
   gh workflow run e2e-test-manual.yml --ref main -F workerNodesCount=2 -F controlNodesCount=1 -F autoscale=false -F cloudProvider=gcp -F machineType=n2d-standard-4 -F sonobuoyTestSuiteCmd="--mode quick" -F kubernetesVersion=1.23 -F coreosImage=projects/constellation-images/global/images/constellation-v1-3-0 -F isDebugImage=false
   

4. Create a new tag in constellation on main
   • git tag v1.3.0
   • Run Release CLI action on the tag

   gh workflow run release-cli.yml --ref v1.3.0
   

   • The previous step will create a draft release. Check build output for link to draft release. Review & approve.
5. Create a new tag in constellation-docs
   • git tag v1.3.0