docs: clarify that helm-diff uses helm template by default#960
Merged
docs: clarify that helm-diff uses helm template by default#960
Conversation
The README intro incorrectly implied that helm-diff uses helm upgrade --debug --dry-run by default. In reality, it uses helm template by default, and helm upgrade --dry-run is only used when HELM_DIFF_USE_UPGRADE_DRY_RUN=true is set. Fixes #666 Signed-off-by: yxxhero <aiopsclub@163.com>
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
1 participant
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.
Summary
helm templateby default to render manifestshelm upgrade --dry-runis only used whenHELM_DIFF_USE_UPGRADE_DRY_RUN=trueis sethelm upgradeorhelm template#666Context
The original README intro was confusing because it implied
helm upgrade --debug --dry-runwas used by default, but later in the docs it states thathelm templateis the default andhelm upgrade --dry-runrequires settingHELM_DIFF_USE_UPGRADE_DRY_RUN=true.This aligns the intro with the actual code behavior in
cmd/helm.go:subcmd = "template"subcmd = "upgrade"with--dry-runflag