Skip to content

Commit 2b559d6

Browse files
Added Source Installation Documentation (#276)
* Update README.md Added documentation to install from source * Update Makefile Added build dependency on install/helm3 * Linting in README.md
1 parent d42b177 commit 2b559d6

File tree

2 files changed

+22
-1
lines changed

2 files changed

+22
-1
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ install: build
2222
cp plugin.yaml $(HELM_HOME)/plugins/helm-diff/
2323

2424
.PHONY: install/helm3
25-
install/helm3:
25+
install/helm3: build
2626
mkdir -p $(HELM_3_PLUGINS)/helm-diff/bin
2727
cp bin/diff $(HELM_3_PLUGINS)/helm-diff/bin
2828
cp plugin.yaml $(HELM_3_PLUGINS)/helm-diff/

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,27 @@ E.g.
2828
curl -L $TARBALL_URL | tar -C $(helm home)/plugins -xzv
2929
```
3030

31+
### From Source
32+
#### Prerequisites
33+
- GoLang `>= 1.14`
34+
35+
Make sure you do not have a verison of `helm-diff` installed. You can remove it by running `helm plugin uninstall diff`
36+
37+
#### Installation Steps
38+
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.
39+
40+
Next, depending on which helm version you have, install the plugin into helm.
41+
42+
##### Helm 2
43+
```bash
44+
make install
45+
```
46+
47+
##### Helm 3
48+
```bash
49+
make install/helm3
50+
```
51+
3152

3253
## Usage
3354

0 commit comments

Comments
 (0)