Skip to content

Commit

Permalink
Add instructions on how to yank a flytectl release
Browse files Browse the repository at this point in the history
Signed-off-by: Eduardo Apolinario <[email protected]>
  • Loading branch information
eapolinario committed Dec 12, 2024
1 parent 2a7d363 commit aace303
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions flytectl/RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,15 @@
Flytectl releases map to git tags with the prefix `flytectl/` followed by a semver string, e.g. [flytectl/v0.9.0](https://github.com/flyteorg/flyte/releases/tag/flytectl%2Fv0.9.0).

To release a new version of flytectl run the <[github workflow](https://github.com/flyteorg/flyte/blob/master/.github/workflows/flytectl-release.yml), which is responsible for releasing this new version. Remember to use valid semver versions, including adding the prefix `v`, e.g. `v1.2.3`.

# How to yank a release?

Keep in mind that if you remove the git tag corresponding to the latest version before fixing homebrew as per the instructions in the section below then installing flytectl via homebrew will be broken. Consider the option of releasing a new version instead.

## From homebrew

We store the flytectl homebrew formula in https://github.com/flyteorg/homebrew-tap. Notice how only a specific version is exposed, so if the version you need to yank is the latest version, simply push a commit pointing to an earlier version (which should be a previous commit).

## From the `install.sh` script
Remove the git tag corresponding to the release from the repo (e.g. `flytectl/v0.9.3`) to force the corresponding version to not be returned in the call to list versions in both the [install.sh script](https://github.com/flyteorg/flyte/blob/master/flytectl/install.sh).

0 comments on commit aace303

Please sign in to comment.