From 4eb28d0535e547408b5516b2f4de8d23c0f19284 Mon Sep 17 00:00:00 2001 From: yxxhero Date: Tue, 24 Mar 2026 08:38:19 +0800 Subject: [PATCH] docs: clarify that helm-diff uses helm template by default 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 --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0476fc48..42d831f9 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,8 @@ This is a Helm plugin giving you a preview of what a `helm upgrade` would change. It basically generates a diff between the latest deployed version of a release -and a `helm upgrade --debug --dry-run`. This can also be used to compare two -revisions/versions of your helm release. +and a `helm template`-rendered manifest (or `helm upgrade --dry-run` when `HELM_DIFF_USE_UPGRADE_DRY_RUN=true` is set). +This can also be used to compare two revisions/versions of your helm release.