Repository navigation
docs: lookup only runs for template, install and upgrade - #2307
Merged
Merged
Conversation
The lookup section told readers to use `helm delete|rollback --dry-run=server` to test lookup against a cluster. Neither command renders templates: rollback reapplies the stored manifest of an earlier revision and uninstall deletes the stored resources, so lookup is never called. In Helm 3 both commands also take a boolean --dry-run, and `helm rollback --dry-run=server` fails with `invalid argument "server" for "--dry-run" flag`. Signed-off-by: YoungjuKim <[email protected]>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
The
lookupsection of "Template Functions and Pipelines" (current docs andversion-3) says:delete(uninstall) androllbackdo not belong in this list:pkg/action/rollback.gobuilds the target release frompreviousRelease.Manifest, and uninstall deletes the resources recorded in the stored release.lookupis never called by either command, so there is nothing to test with them.cmd/helm/rollback.go:f.BoolVar(&client.DryRun, "dry-run", ...), unchanged onv3.22.1, and the same for uninstall). The documented flag is rejected:In Helm 4,
helm uninstall --dry-runis still a boolean (pkg/cmd/uninstall.go).This PR removes the two commands from the sentence in
docs/andversioned_docs/version-3/. It also says whylookupdoes not run for them. The rest of the paragraph is unchanged. I did not change the translated copies underi18n/.How I checked the rest of the sentence (Helm v3.18.2, against a cluster, with a one-template chart that renders
(lookup "v1" "Namespace" "" "kube-system").metadata.name):helm template d ./chartnil pointer evaluating interface {}.namehelm template d ./chart --dry-run=clienthelm template d ./chart --dry-run=serverfound: "kube-system"Special notes for your reviewer:
I did not run
yarn buildlocally. This is a text-only change to one paragraph in two files.This change was drafted with AI assistance and reviewed by me.
🤖 Generated with Claude Code