cilium / tetragon

eBPF-based Security Observability and Runtime Enforcement

Home Page:https://tetragon.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

v1.1.1 release

kkourt opened this issue · comments

Tetragon release checklist

  • Check that there are no release blockers.

  • Set RELEASE environment variable. For example, if you are releasing v0.8.1:

    export RELEASE=v0.8.1
    
  • Open a pull request to update the Helm chart and docs:

    git checkout -b pr/prepare-$RELEASE
    
    # update Helm chart
    ./contrib/update-helm-chart.sh $RELEASE
    make -C install/kubernetes
    git add install/kubernetes/tetragon/
    
    # update version in docs (Hugo config)
    sed -i "s/^version =.*/version = \"${RELEASE}\"/" docs/hugo.toml
    git add docs/
    
    # update upgrade notes
    ./contrib/update-upgrade-notes.sh $RELEASE
    git add contrib/upgrade-notes/
    
    git commit -s -m "Prepare for $RELEASE release"
    git push origin HEAD
    
  • Once the pull request gets merged, create a tag for the release:

    git checkout main
    git pull origin main
    git tag -a $RELEASE -m "$RELEASE release" -s
    git tag -a api/$RELEASE -m "api/$RELEASE release" -s
    git push origin $RELEASE
    
  • If you are releasing a major or minor version (X.Y.0):

    • Create vX.Y branch from the tag you pushed
    • Create a "Starting X.Y+1 development" PR to the main branch with the following changes:
    • Once PR is merged, tag the first commit in the main branch which is not in the X.Y branch as vX.Y+1.0-pre.0. The high level view of the status after this tag is shown in the following figure (RELEASE is v0.10.0 in this example):
gitGraph
    commit
    commit tag: "v0.10.0"
    branch "v0.10"
    commit
    commit
    checkout main
    commit id: "CRD -> v0.11.0" tag: "v0.11.0-pre.0"
    commit
    commit
    checkout "v0.10"
    commit
    commit
    commit tag: "v0.10.1"

Loading
  • Go to Image CI Releases workflow and wait for the release image build to finish.

  • When a tag is pushed, a GitHub Action job takes care of creating a new GitHub
    draft release, building artifacts and attaching them to the draft release. Once
    the draft is available in the releases page:

    • Use tgt-notes from tetragon-github-tools
      to generate a first version of the release notes based on release-note/ tags and PR messages.
    • Copy upgrade notes from contrib/upgrade-notes/vX.Y.Z.md file into the release notes.
      (Skip if there are no upgrade notes - it's quite likely for patch releases).
    • Review the release notes and update them as needed.
    • Make sure the "Set as a pre-release" and "Set as the latest release" checkboxes are set correctly.
      Every -pre.N or -rc.N release should be marked as a pre-release, and a stable release with the highest
      version should be marked as latest.
    • Click on "Publish Release" at the bottom.
  • Publish Helm chart

Release for v1.1.1 was incomplete due to: #2538.
Closing this and starting v1.1.2.