Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add instructions on how to yank a flytectl release #6105

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add instructions on how to yank a flytectl release #6105

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions flytectl/RELEASE.md
View file
Open in desktop
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).

Loading