1
0
mirror of https://github.com/lensapp/lens.git synced 2025-05-20 05:10:56 +00:00
lens/RELEASE_GUIDE.md
Jim Ehrismann a0d4558d7b updating release guide with more details
Signed-off-by: Jim Ehrismann <jehrismann@miranits.com>
2021-08-31 12:35:08 -04:00

2.7 KiB

Release Process

Lens releases are built by CICD automatically on git tags. The typical release process flow is the following:

  1. From a clean and up to date master run make release-version <version-type> where <version-type> is one of the following:
    • major
    • minor
    • patch
    • premajor
    • preminor
    • prepatch
    • prerelease [--preid=<prerelease-id>]
  2. Open the PR (git should have printed a link to GitHub in the console) with the contents of all the accepted PRs since the last release. The PR description needs to be filled with the draft release description. From https://github.com/lensapp/lens click on Releases, the draft release should be first in the list, click Edit and copy/paste the markdown to the PR description. Add the skip-changelog label and click Create Pull Request.
  3. After the PR is accepted and passes CI (and before merging), go to the same branch and run make tag-release (set GIT_REMOTE if necessary). This additionally runs the azure jobs to build the binaries and put them on S3.
  4. If the CI fails at this stage the problem needs to be fixed, changes committed to the release branch and pushed to https://github.com/lensapp/lens. CI will run again. As well the release tag needs to be manually set to this new commit. You can do something like:
  1. Once CI passes again go to the releases tab on GitHub. If you did not have to fix any problems and did not manually reset the tag you can use the existing draft release prepared by k8slens-bot. Otherwise create a new release from the tag that was created, make sure that the change log is the same as that of the PR, and the title is the tag. Either way, click the prerelease checkbox if this is not a new major or minor version before clicking Publish release.
  2. Merge the release PR after the release is published. GitHub should delete the branch once it is merged.
  3. If you have just released a new major or minor version then create a new vMAJOR.MINOR branch from that same tag and push it to master. This will be the target for future patch releases and shouldn't be deleted.