Skip to content
Merged
Changes from all commits
Commits
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
9 changes: 8 additions & 1 deletion docs/krel/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,18 @@ Kubernetes Releases. This includes manually executed tasks like generating the R

## Installation

Compile krel by running the `compile-release-tools` script from the root of this repo:
Either Compile krel by running the `compile-release-tools` script from the root of this repo:

```shell
./compile-release-tools krel
```
Or

Run the following command in the terminal:

```
go install k8s.io/release/cmd/krel@latest
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I verified that the krel installed using go install runs fine but the krel version command will report wrong values for some variables. I am not sure if commands other than stage, release would break.

@kubernetes/release-engineering -- what do you think?

Copy link
Member

@saschagrunert saschagrunert Jan 24, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the version output is more a cosmetic thing depending on how it has been installed.

```

## Usage:

Expand Down