Skip to content

Latest commit

 

History

History
90 lines (88 loc) · 4.96 KB

RELEASING.md

File metadata and controls

90 lines (88 loc) · 4.96 KB
Raw

Releasing

  1. Checkout your fork and make sure it's up-to-date with the upstream 
    $ git remote -v
origin     [email protected]:<your account>/starboard.git (fetch)
origin     [email protected]:<your account>/starboard.git (push)
upstream   [email protected]:aquasecurity/starboard.git (fetch)
upstream   [email protected]:aquasecurity/starboard.git (push)
    git pull -r
git fetch upstream
git merge upstream/main
git push
  2. Prepare release by creating the PR with the following changes
    1. In deploy/helm/Chart.yaml
      1. Update the version property
      2. Update the appVersion property
    2. Update container image tag in deploy/static/05-starboard-operator.deployment.yaml
    3. Update the app.kubernetes.io/version labels in the following files:
      1. deploy/crd/ciskubebenchreports.crd.yaml
      2. deploy/crd/clustercompliancedetailreports.crd.yaml
      3. deploy/crd/clustercompliancereports.crd.yaml
      4. deploy/crd/clusterconfigauditreports.crd.yaml
      5. deploy/crd/clustervulnerabilityreports.crd.yaml
      6. deploy/crd/configauditreports.crd.yaml
      7. deploy/crd/kubehunterreports.crd.yaml
      8. deploy/crd/vulnerabilityreports.crd.yaml
      9. deploy/static/05-starboard-operator.deployment.yaml
      10. deploy/static/04-starboard-operator.policies.yaml
      11. deploy/static/03-starboard-operator.config.yaml
      12. deploy/static/02-starboard-operator.rbac.yaml
      13. deploy/static/01-starboard-operator.ns.yaml
      14. deploy/specs/nsa-1.0.yaml
    4. Update deploy/static/starboard.yaml by running the following script: 
      ./hack/update-starboard.yaml.sh
    5. In mkdocs.yml
      1. Update the extra.var.prev_git_tag property
      2. Update the extra.var.chart_version property
  3. Review and merge the PR (make sure all tests are passing)
  4. Update your fork again 
    git pull -r
git fetch upstream
git merge upstream/main
git push
  5. Create an annotated git tag and push it to the upstream. This will trigger the .github/workflows/release.yaml workflow 
    git tag -v0.13.1 -m 'Release v0.13.1'
git push upstream v0.13.1
  6. Verify that the release workflow has built and published the following artifacts
    1. Starboard CLI binary executables for various platforms on https://github.com/aquasecurity/starboard/releases/tag/v0.13.1
    2. Starboard container images published to DockerHub
      1. docker.io/aquasec/starboard:0.13.1
      2. docker.io/aquasec/starboard-operator:0.13.1
      3. docker.io/aquasec/starboard-scanner-aqua:0.13.1
    3. Starboard container images published to Amazon ECR Public Gallery
      1. public.ecr.aws/aquasecurity/starboard:0.13.1
      2. public.ecr.aws/aquasecurity/starboard-operator:0.13.1
      3. public.ecr.aws/aquasecurity/starboard-scanner-aqua:0.13.1
  7. Publish the Helm chart by manually triggering the .github/workflows/publish-helm-chart.yaml workflow
  8. Publish docs on https://aquasecurity.github.io/starboard/ by manually triggering the .github/workflows/publish-docs.yaml workflow
  9. Submit Starboard Operator to OperatorHub and ArtifactHUB by opening the PR to the https://github.com/k8s-operatorhub/community-operators repository.