Skip to content

Commit e1559c9

Browse files
authored
docs: clarify that helm-diff uses helm template by default (#960)
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>
1 parent 203ed37 commit e1559c9

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66

77
This is a Helm plugin giving you a preview of what a `helm upgrade` would change.
88
It basically generates a diff between the latest deployed version of a release
9-
and a `helm upgrade --debug --dry-run`. This can also be used to compare two
10-
revisions/versions of your helm release.
9+
and a `helm template`-rendered manifest (or `helm upgrade --dry-run` when `HELM_DIFF_USE_UPGRADE_DRY_RUN=true` is set).
10+
This can also be used to compare two revisions/versions of your helm release.
1111

1212
<a href="https://asciinema.org/a/105326" target="_blank"><img src="https://asciinema.org/a/105326.png" /></a>
1313

0 commit comments

Comments
 (0)