Skip to content

Correct Helm flag from --set-string to --set in docs and CLI examples#11404

Merged
brooke-hamilton merged 3 commits intoradius-project:mainfrom
brooke-hamilton:brooke-hamilton/set-string-fix
Mar 14, 2026
Merged

Correct Helm flag from --set-string to --set in docs and CLI examples#11404
brooke-hamilton merged 3 commits intoradius-project:mainfrom
brooke-hamilton:brooke-hamilton/set-string-fix

Conversation

@brooke-hamilton
Copy link
Copy Markdown
Member

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
    • Not applicable
  • A design document PR is created in the design-notes repository, if new APIs are being introduced.
    • Yes
    • Not applicable
  • The design document has been reviewed and approved by Radius maintainers/approvers.
    • Yes
    • Not applicable
  • A PR for the samples repository is created, if existing samples are affected by the changes in this PR.
    • Yes
    • Not applicable
  • A PR for the documentation repository is created, if the changes in this PR affect the documentation or any user facing updates are made.
    • Yes
    • Not applicable
  • A PR for the recipes repository is created, if existing recipes are affected by the changes in this PR.
    • Yes
    • Not applicable

Signed-off-by: Brooke Hamilton <45323234+brooke-hamilton@users.noreply.github.com>
@brooke-hamilton brooke-hamilton requested a review from a team as a code owner March 9, 2026 23:36
Copilot AI review requested due to automatic review settings March 9, 2026 23:36
@brooke-hamilton brooke-hamilton requested a review from a team as a code owner March 9, 2026 23:36
@brooke-hamilton brooke-hamilton changed the title Corrected Helm flag from --set-string to --set in docs and CLI examples Correct Helm flag from --set-string to --set in docs and CLI examples Mar 9, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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-string with --set in rad install, rad init, and rad upgrade CLI example text.
  • Updated contributing docs to use --set for global.imagePullSecrets examples.
  • Updated the Helm chart README’s rad install example 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.

Comment thread deploy/Chart/README.md
@codecov
Copy link
Copy Markdown

codecov Bot commented Mar 10, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 51.24%. Comparing base (11e61e3) to head (6caa229).
⚠️ Report is 1 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@radius-functional-tests
Copy link
Copy Markdown

radius-functional-tests Bot commented Mar 14, 2026

Radius functional test overview

🔍 Go to test action run

Click here to see the test run details
Name Value
Repository brooke-hamilton/radius
Commit ref 6caa229
Unique ID func236ae46269
Image tag pr-func236ae46269
  • gotestsum 1.13.0
  • KinD: v0.29.0
  • Dapr: 1.14.4
  • Azure KeyVault CSI driver: 1.4.2
  • Azure Workload identity webhook: 1.3.0
  • Bicep recipe location ghcr.io/radius-project/dev/test/testrecipes/test-bicep-recipes/<name>:pr-func236ae46269
  • Terraform recipe location http://tf-module-server.radius-test-tf-module-server.svc.cluster.local/<name>.zip (in cluster)
  • applications-rp test image location: ghcr.io/radius-project/dev/applications-rp:pr-func236ae46269
  • dynamic-rp test image location: ghcr.io/radius-project/dev/dynamic-rp:pr-func236ae46269
  • controller test image location: ghcr.io/radius-project/dev/controller:pr-func236ae46269
  • ucp test image location: ghcr.io/radius-project/dev/ucpd:pr-func236ae46269
  • deployment-engine test image location: ghcr.io/radius-project/deployment-engine:latest

Test Status

⌛ Building Radius and pushing container images for functional tests...
✅ Container images build succeeded
⌛ Publishing Bicep Recipes for functional tests...
✅ Recipe publishing succeeded
⌛ Starting ucp-cloud functional tests...
⌛ Starting corerp-cloud functional tests...
✅ ucp-cloud functional tests succeeded
✅ corerp-cloud functional tests succeeded

@brooke-hamilton brooke-hamilton merged commit c30a4e2 into radius-project:main Mar 14, 2026
55 checks passed
willtsai pushed a commit that referenced this pull request Mar 30, 2026
…#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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants