From 5a21388be19d51308c02ee9709b3b0b1609f9701 Mon Sep 17 00:00:00 2001 From: Mark Said Camilleri Date: Mon, 19 Apr 2021 20:04:37 +0100 Subject: [PATCH 1/3] Update README.md Added documentation to install from source --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index 79cb39fb..524dc37e 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,29 @@ curl -L $TARBALL_URL | tar -C $(helm home)/plugins -xzv ``` +### From Source +#### Prerequisites + - GoLang `>= 1.14` + +Make sure you do not have a verison of `helm-diff` installed. You can remove it by running `helm plugin uninstall diff` + +#### Installation Steps +The first step is to download the repository and enter the directory. You can do this via `git clone` or downloaing and extracting the release. If you clone via git, remember to checkout the latest tag for the latest release. + +Next, depending on which helm version you have, install the plugin into helm. + +##### Helm 2 + +```bash +make install +``` + +##### Helm 3 +```bash +make install/helm3 +``` + + ## Usage ``` From 30f914662c672cc738afb573115fe977cd01bb50 Mon Sep 17 00:00:00 2001 From: Mark Said Camilleri Date: Mon, 19 Apr 2021 20:05:22 +0100 Subject: [PATCH 2/3] Update Makefile Added build dependency on install/helm3 --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 3c9ad52a..2ba9e006 100644 --- a/Makefile +++ b/Makefile @@ -22,7 +22,7 @@ install: build cp plugin.yaml $(HELM_HOME)/plugins/helm-diff/ .PHONY: install/helm3 -install/helm3: +install/helm3: build mkdir -p $(HELM_3_PLUGINS)/helm-diff/bin cp bin/diff $(HELM_3_PLUGINS)/helm-diff/bin cp plugin.yaml $(HELM_3_PLUGINS)/helm-diff/ From b17ac976eedda2dd397887ce3235b1f34a04042a Mon Sep 17 00:00:00 2001 From: Mark Said Camilleri Date: Mon, 19 Apr 2021 20:12:19 +0100 Subject: [PATCH 3/3] Linting in README.md --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 524dc37e..e941a3d7 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,6 @@ E.g. curl -L $TARBALL_URL | tar -C $(helm home)/plugins -xzv ``` - ### From Source #### Prerequisites - GoLang `>= 1.14` @@ -41,7 +40,6 @@ The first step is to download the repository and enter the directory. You can do Next, depending on which helm version you have, install the plugin into helm. ##### Helm 2 - ```bash make install ```