Release Checklist 0.148.0

[steven-sheehy]

Problem

This checklist verifies a release is rolled out successfully.

Solution

Preparation

• Milestone created
• Milestone field populated on relevant issues
• Nothing open for milestone
• GitHub checks for branch are passing
• No breaking changes in API schema or behavior
• No pre-release or snapshot dependencies present in build files
• Verify HAPI protobuf dependency doesn't contain any unsupported fields or messages
• Automated Kubernetes deployment to integration successful
• Integration HAPI version is up to date with previewnet
• No abnormal exceptions in importer logs in integration since the first SNAPSHOT
• Tag release via manual invocation of Release Automation workflow with x.y.z-rc1 format tag
• Approve and merge PR that bumps main to next snapshot version

Release Candidates

Previewnet

Deployed automatically on every tag.

• Deployed
• Helm Controller logs show successful reconciliation check
• Helm release status is healthy

Performance

• Create deploy branch PR to bump versions in clusters/preprod/(common|performance-citus)/helmrelease.yaml
• Verify with QA team that it's safe to deploy before merging
• Deployed
• Helm Controller logs show successful reconciliation check
• Helm release status is healthy
• gRPC API performance tests
• Importer performance tests

Mainnet Staging

• Create deploy branch PR to bump versions in clusters/mainnet-staging-na/(common|mainnet-citus)/helmrelease.yaml
• Deployed
• Helm Controller logs show successful reconciliation check
• Helm release status is healthy
• No abnormal exceptions in importer logs
• REST API performance tests
• REST Java API performance tests
• Web3 API performance tests
• Run the Copy StackGres Citus Cluster workflow to tear down the cluster
  • Uncheck Restore the target cluster from the source
  • Uncheck Run k6 test
  • Check Tear down target cluster

Generally Available

• Tag release via manual invocation of Release Automation workflow with GA tag
• Manager writes release notes and publishes GitHub release
• Publish marketplace release

Previewnet

Deployed automatically on every tag.

• Deployed
• Helm Controller logs show successful reconciliation check
• Helm release status is healthy
• Disable state proof alpha by removing all config in secret and HelmRelease

Testnet

A GA tag will trigger an automatic deployment to NA. Upon success, a PR for EU will automatically get created.

• Configure cross cluster health check NA
• Disable state proof alpha by removing all config in secret and HelmRelease NA
• Latest Citus backup is successful
• Deployed NA
• Helm Controller logs show successful reconciliation check NA
• Helm release status is healthy NA
• Configure cross cluster health check EU
• Disable state proof alpha by removing all config in secret and HelmRelease EU
• Approve and merge automated PR to bump versions on testnet-eu
• Deployed EU
• Helm Controller logs show successful reconciliation check EU
• Helm release status is healthy EU

Pre-Production

These preprod environments are automatically deployed for any GA release. Ensure the deployments are successful.

• Dev
• Integration Docker
• Staging Council
• Staging Large
• Staging Small

Mainnet

Wait about a week after the testnet deployment to give it time to bake, then deploy to NA first. Upon success, a PR for
EU will automatically get created.

• Configure cross cluster health check NA
• Disable state proof alpha by removing all config in secret and HelmRelease NA
• Latest Citus backup is successful
• Create deploy branch PR to bump versions in clusters/mainnet-na/(common|mainnet-citus)/helmrelease.yaml
• Resume Kustomization and HelmRelease NA
• Deployed NA
• Helm Controller logs show successful reconciliation check NA
• Helm release status is healthy NA
• Configure cross cluster health check EU
• Disable state proof alpha by removing all config in secret and HelmRelease EU
• Approve and merge automated PR to bump versions on mainnet-eu
• Resume Kustomization and HelmRelease NA
• Deployed EU
• Helm Controller logs show successful reconciliation check EU
• Helm release status is healthy EU

Post Release

• Update any completed HIPs to Final status and populate the release.

Alternatives

No response