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.

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

docs: Specify steps to ensure clean state when releasing #4963

Merged
merged 1 commit into from
Jan 28, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/releasing.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,15 @@ Allow 1h to do a release.

## Release

Releasing requires a clean tree state, so back-up any untracked files in your Git directory.

**Only once your files are backed up**, run:

git clean -fdx # WARNING: Will delete untracked files!

To generate new manifests and perform basic checks:

make prepare-release VERSION=v2.11.5
make prepare-release -B VERSION=v2.11.5

Publish the images and local Git changes (disabling K3D as this is faster and more reliable for releases):

Expand Down