Correct Helm flag from --set-string to --set in docs and CLI examples#11404
Conversation
Signed-off-by: Brooke Hamilton <45323234+brooke-hamilton@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Updates Radius documentation and CLI help examples to use Helm-style --set (instead of --set-string) when setting global.imagePullSecrets[*].name, aligning examples with the intended Helm values usage.
Changes:
- Replaced
--set-stringwith--setinrad install,rad init, andrad upgradeCLI example text. - Updated contributing docs to use
--setforglobal.imagePullSecretsexamples. - Updated the Helm chart README’s
rad installexample to use--set.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| deploy/Chart/README.md | Updates CLI example for imagePullSecrets to use --set (but leaves one Helm snippet unchanged). |
| docs/contributing/contributing-code/contributing-code-control-plane/generating-and-installing-custom-build.md | Updates imagePullSecrets example to use --set. |
| docs/contributing/contributing-code/contributing-code-tests/testing-local.md | Updates imagePullSecrets example to use --set. |
| pkg/cli/cmd/install/kubernetes/kubernetes.go | Updates command help examples to use --set. |
| pkg/cli/cmd/radinit/init.go | Updates command help examples to use --set. |
| pkg/cli/cmd/upgrade/kubernetes/kubernetes.go | Updates command help examples to use --set. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #11404 +/- ##
=======================================
Coverage 51.24% 51.24%
=======================================
Files 699 699
Lines 44062 44062
=======================================
Hits 22580 22580
Misses 19326 19326
Partials 2156 2156 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Radius functional test overviewClick here to see the test run details
Test Status⌛ Building Radius and pushing container images for functional tests... |
…#11404) # Description Replaces `--set-string` with `--set` for `global.imagePullSecrets` in documentation and CLI command examples. The `--set-string` flag is unnecessary here because the values being set are already strings, and using `--set` is the standard and correct approach for these Helm chart values. ## Type of change - This pull request is a minor refactor, code cleanup, test improvement, or other maintenance task and does not change the functionality of Radius (issue link optional). ## Changes - **deploy/Chart/README.md**: Changed `--set-string` to `--set` for `imagePullSecrets` example - **docs/contributing/contributing-code/contributing-code-control-plane/generating-and-installing-custom-build.md**: Changed `--set-string` to `--set` for `imagePullSecrets` example - **docs/contributing/contributing-code/contributing-code-tests/testing-local.md**: Changed `--set-string` to `--set` for `imagePullSecrets` example - **pkg/cli/cmd/install/kubernetes/kubernetes.go**: Updated CLI help text examples to use `--set` instead of `--set-string` - **pkg/cli/cmd/radinit/init.go**: Updated CLI help text examples to use `--set` instead of `--set-string` - **pkg/cli/cmd/upgrade/kubernetes/kubernetes.go**: Updated CLI help text examples to use `--set` instead of `--set-string` ## Contributor checklist Please verify that the PR meets the following requirements, where applicable: - An overview of proposed schema changes is included in a linked GitHub issue. - [ ] Yes <!-- TaskRadio schema --> - [x] Not applicable <!-- TaskRadio schema --> - A design document PR is created in the [design-notes repository](https://github.com/radius-project/design-notes/), if new APIs are being introduced. - [ ] Yes <!-- TaskRadio design-pr --> - [x] Not applicable <!-- TaskRadio design-pr --> - The design document has been reviewed and approved by Radius maintainers/approvers. - [ ] Yes <!-- TaskRadio design-review --> - [x] Not applicable <!-- TaskRadio design-review --> - A PR for the [samples repository](https://github.com/radius-project/samples) is created, if existing samples are affected by the changes in this PR. - [ ] Yes <!-- TaskRadio samples-pr --> - [x] Not applicable <!-- TaskRadio samples-pr --> - A PR for the [documentation repository](https://github.com/radius-project/docs) is created, if the changes in this PR affect the documentation or any user facing updates are made. - [ ] Yes <!-- TaskRadio docs-pr --> - [x] Not applicable <!-- TaskRadio docs-pr --> - A PR for the [recipes repository](https://github.com/radius-project/recipes) is created, if existing recipes are affected by the changes in this PR. - [ ] Yes <!-- TaskRadio recipes-pr --> - [x] Not applicable <!-- TaskRadio recipes-pr --> Signed-off-by: Brooke Hamilton <45323234+brooke-hamilton@users.noreply.github.com> Signed-off-by: Will Tsai <28876888+willtsai@users.noreply.github.com>
Description
Replaces
--set-stringwith--setforglobal.imagePullSecretsin documentation and CLI command examples. The--set-stringflag is unnecessary here because the values being set are already strings, and using--setis the standard and correct approach for these Helm chart values.Type of change
Changes
--set-stringto--setforimagePullSecretsexample--set-stringto--setforimagePullSecretsexample--set-stringto--setforimagePullSecretsexample--setinstead of--set-string--setinstead of--set-string--setinstead of--set-stringContributor checklist
Please verify that the PR meets the following requirements, where applicable: