Add example using helm repo to helm installation guide by avrittrohwer · Pull Request #3517 · kubernetes-sigs/kueue

avrittrohwer · 2024-11-12T18:28:39Z

What type of PR is this?

/kind documentation

What this PR does / why we need it:

Makes the helm OCI repo more discoverable.

Which issue(s) this PR fixes:

Special notes for your reviewer:

Does this PR introduce a user-facing change?

NONE

k8s-ci-robot · 2024-11-12T18:28:49Z

Hi @avrittrohwer. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

netlify · 2024-11-12T18:28:57Z

✅ Deploy Preview for kubernetes-sigs-kueue canceled.

Name	Link
🔨 Latest commit	`d772cfb`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-sigs-kueue/deploys/6733a96760daa900086a1ab3

mbobrovskyi · 2024-11-12T18:33:52Z

/ok-to-test

mbobrovskyi · 2024-11-12T18:43:17Z

+Or use the charts pushed to `us-central1-docker.pkg.dev/k8s-staging-images/charts/kueue`:
+
+```bash
+VERSION=v0.9.0


Could you please add file path for this file here

kueue/Makefile

Line 282 in 43b7374

$(SED) -r 's/v[0-9]+\.[0-9]+\.[0-9]+/$(RELEASE_VERSION)/g' -i README.md -i site/hugo.toml

to replace version on make prepare-release-branch.

Ah it will not work due to https://github.com/kubernetes-sigs/kueue/pull/3517/files#diff-5a79cc43ce0679eff1846acc8c2efd23837400593d4d593a46156dff0b8d1773R60.

How about https://github.com/kubernetes-sigs/kueue/pull/3517/files#diff-76ed074a9305c04054cdebb9e9aad2d818052b07091de1f20cad0bbac34ffb52R283?

Tested with $ sed -r 's/--version="v[0-9]+\.[0-9]+\.[0-9]+/--version="v0.9.1/g' -i charts/kueue/README.md

$ gd diff --git a/Makefile b/Makefile index dcf8edbb..0e343dd8 100644 --- a/Makefile +++ b/Makefile @@ -280,6 +280,7 @@ artifacts: kustomize yq helm ## Generate release artifacts. .PHONY: prepare-release-branch prepare-release-branch: yq kustomize ## Prepare the release branch with the release version. $(SED) -r 's/v[0-9]+\.[0-9]+\.[0-9]+/$(RELEASE_VERSION)/g' -i README.md -i site/hugo.toml -i charts/kueue/README.md + $(SED) -r 's/--version="v[0-9]+\.[0-9]+\.[0-9]+/--version="$(RELEASE_VERSION)/g' -i charts/kueue/README.md $(YQ) e '.appVersion = "$(RELEASE_VERSION)"' -i charts/kueue/Chart.yaml @$(call clean-manifests) diff --git a/charts/kueue/README.md b/charts/kueue/README.md index fbcb94d9..6609cec9 100644 --- a/charts/kueue/README.md +++ b/charts/kueue/README.md @@ -35,7 +35,7 @@ $ helm install kueue kueue/ --create-namespace --namespace kueue-system Or use the charts pushed to `us-central1-docker.pkg.dev/k8s-staging-images/charts/kueue`: ```bash -helm install kueue oci://us-central1-docker.pkg.dev/k8s-staging-images/charts/kueue --version="v0.9.0" --create-namespace --namespace=kueue-system +helm install kueue oci://us-central1-docker.pkg.dev/k8s-staging-images/charts/kueue --version="v0.9.1" --create-namespace --namespace=kueue-system

Co-authored-by: Mykhailo Bobrovskyi <mikhail.bobrovsky@gmail.com>

mbobrovskyi · 2024-11-12T19:07:49Z

/lgtm
Thanks!

k8s-ci-robot · 2024-11-12T19:07:55Z

LGTM label has been added.

Details

Git tree hash: cd289c54937372a78e7a332152186be0b985facb

mbobrovskyi · 2024-11-12T19:08:04Z

/cc @mimowo

mbobrovskyi · 2024-11-12T19:15:10Z

 .PHONY: prepare-release-branch
 prepare-release-branch: yq kustomize ## Prepare the release branch with the release version.
-	$(SED) -r 's/v[0-9]+\.[0-9]+\.[0-9]+/$(RELEASE_VERSION)/g' -i README.md -i site/hugo.toml
+	$(SED) -r 's/v[0-9]+\.[0-9]+\.[0-9]+/$(RELEASE_VERSION)/g' -i README.md -i site/hugo.toml -i charts/kueue/README.md


Suggested change

$(SED) -r 's/v[0-9]+\.[0-9]+\.[0-9]+/$(RELEASE_VERSION)/g' -i README.md -i site/hugo.toml -i charts/kueue/README.md

$(SED) -r 's/v[0-9]+\.[0-9]+\.[0-9]+/$(RELEASE_VERSION)/g' -i README.md -i site/hugo.toml

Only one thing. Could you please revert?

Ah, good catch!

mbobrovskyi · 2024-11-12T19:39:51Z

/lgtm
Thanks!

k8s-ci-robot · 2024-11-12T19:39:57Z

LGTM label has been added.

Details

Git tree hash: 5f54bd22df8539269f585de99f40e0d3ab481f11

mimowo

This is awesome, thank you!
/lgtm
/approve
/cherry-pick website

k8s-ci-robot · 2024-11-13T09:17:26Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: avrittrohwer, mbobrovskyi, mimowo

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

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [mimowo]

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

mbobrovskyi · 2024-11-13T09:20:13Z

Do we need to cherry-pick this to the website? It looks like it’s just changes to the Helm docs.

mimowo · 2024-11-13T09:32:41Z

Helm docs are part of documentation, so it feels better to cherry-pick it.

mimowo · 2024-11-13T10:14:28Z

Ah, I see, we reference the link from "main" for helm, so it already displays the information for those who follow the link.
So no cherry-pick needed. We may though consider the commands to be part of website before following the link, but this is for another (potential) improvement. Thanks for the check @mbobrovskyi

…gs#3517) * Add example using helm repo to helm installation guide * Update charts/kueue/README.md Co-authored-by: Mykhailo Bobrovskyi <mikhail.bobrovsky@gmail.com> * Add kueue README.md to version replace sed * Fix sed replace for kueue helm readme * Remove kueue readme from other sed --------- Co-authored-by: Mykhailo Bobrovskyi <mikhail.bobrovsky@gmail.com>

Add example using helm repo to helm installation guide

51a8011

k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Nov 12, 2024

k8s-ci-robot requested review from tenzen-y and trasc November 12, 2024 18:28

k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Nov 12, 2024

k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Nov 12, 2024

mbobrovskyi reviewed Nov 12, 2024

View reviewed changes

Avritt Rohwer and others added 2 commits November 12, 2024 18:58

Update charts/kueue/README.md

bb8b5ec

Co-authored-by: Mykhailo Bobrovskyi <mikhail.bobrovsky@gmail.com>

Add kueue README.md to version replace sed

409ebba

k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Nov 12, 2024

Fix sed replace for kueue helm readme

a6a7f0e

k8s-ci-robot assigned mbobrovskyi Nov 12, 2024

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 12, 2024

k8s-ci-robot requested a review from mimowo November 12, 2024 19:08

mbobrovskyi reviewed Nov 12, 2024

View reviewed changes

Remove kueue readme from other sed

d772cfb

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 12, 2024

k8s-ci-robot requested a review from mbobrovskyi November 12, 2024 19:15

k8s-ci-robot removed the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Nov 12, 2024

k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Nov 12, 2024

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 12, 2024

mbobrovskyi approved these changes Nov 12, 2024

View reviewed changes

avrittrohwer requested a review from mbobrovskyi November 12, 2024 20:04

mimowo reviewed Nov 13, 2024

View reviewed changes

k8s-ci-robot assigned mimowo Nov 13, 2024

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 13, 2024

k8s-ci-robot merged commit 00a05fc into kubernetes-sigs:main Nov 13, 2024

k8s-ci-robot added this to the v0.10 milestone Nov 13, 2024

	$(SED) -r 's/v[0-9]+\.[0-9]+\.[0-9]+/$(RELEASE_VERSION)/g' -i README.md -i site/hugo.toml -i charts/kueue/README.md
	$(SED) -r 's/v[0-9]+\.[0-9]+\.[0-9]+/$(RELEASE_VERSION)/g' -i README.md -i site/hugo.toml

Uh oh!

Conversation

avrittrohwer commented Nov 12, 2024

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Special notes for your reviewer:

Does this PR introduce a user-facing change?

Uh oh!

k8s-ci-robot commented Nov 12, 2024

Uh oh!

netlify Bot commented Nov 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for kubernetes-sigs-kueue canceled.

Uh oh!

mbobrovskyi commented Nov 12, 2024

Uh oh!

Uh oh!

mbobrovskyi Nov 12, 2024

Choose a reason for hiding this comment

Uh oh!

mbobrovskyi Nov 12, 2024

Choose a reason for hiding this comment

Uh oh!

avrittrohwer Nov 12, 2024

Choose a reason for hiding this comment

Uh oh!

avrittrohwer Nov 12, 2024

Choose a reason for hiding this comment

Uh oh!

mbobrovskyi Nov 12, 2024

Choose a reason for hiding this comment

Uh oh!

mbobrovskyi commented Nov 12, 2024

Uh oh!

k8s-ci-robot commented Nov 12, 2024

Uh oh!

mbobrovskyi commented Nov 12, 2024

Uh oh!

mbobrovskyi Nov 12, 2024

Choose a reason for hiding this comment

Uh oh!

avrittrohwer Nov 12, 2024

Choose a reason for hiding this comment

Uh oh!

mbobrovskyi commented Nov 12, 2024

Uh oh!

k8s-ci-robot commented Nov 12, 2024

Uh oh!

mimowo left a comment

Choose a reason for hiding this comment

Uh oh!

k8s-ci-robot commented Nov 13, 2024

Uh oh!

mbobrovskyi commented Nov 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mimowo commented Nov 13, 2024

Uh oh!

mimowo commented Nov 13, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

netlify Bot commented Nov 12, 2024 •

edited

Loading

mbobrovskyi commented Nov 13, 2024 •

edited

Loading