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

Added Golang Command to install Krel Tool #2870 #2871

Merged
merged 2 commits into from
Jan 24, 2023

Conversation

yrs147
Copy link
Contributor

@yrs147 yrs147 commented Jan 23, 2023

Was facing an issue regarding Krel Installation on windows and I think that the given installation steps might not work for some users, so added the Golang command to simplify the installation of krel tool.

What type of PR is this?

/kind documentation

What this PR does / why we need it:

It is an improvement in Docs for a better user experience

Which issue(s) this PR fixes:

#2870

Special notes for your reviewer:

We can add this in the docs to help new members in release teams who use the krel tool

Does this PR introduce a user-facing change?

No, only improved documentation.

Added Golang command in the documentation for the krel tool installation 

Was facing an issue regarding Krel Installation on windows and I think that the given installation steps might not work for some users, so added the Golang command to simplify the installation of krel tool.
@k8s-ci-robot k8s-ci-robot added kind/documentation Categorizes issue or PR as related to documentation. release-note Denotes a PR that will be considered when it comes time to generate release notes. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-priority labels Jan 23, 2023
@k8s-ci-robot k8s-ci-robot requested a review from cici37 January 23, 2023 17:03
@k8s-ci-robot k8s-ci-robot added the area/release-eng Issues or PRs related to the Release Engineering subproject label Jan 23, 2023
@k8s-ci-robot k8s-ci-robot added sig/release Categorizes an issue or PR as relevant to SIG Release. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jan 23, 2023
docs/krel/README.md Outdated Show resolved Hide resolved
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.

Removed Extra space

Co-authored-by: Nabarun Pal <[email protected]>
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 24, 2023
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: saschagrunert, yrs147

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 24, 2023
@k8s-ci-robot k8s-ci-robot merged commit 3e035ef into kubernetes:master Jan 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/release-eng Issues or PRs related to the Release Engineering subproject cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-priority release-note Denotes a PR that will be considered when it comes time to generate release notes. sig/release Categorizes an issue or PR as relevant to SIG Release. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants