Skip to content

Added Source Installation Documentation #276

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 18, 2021
Merged

Added Source Installation Documentation #276

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5a21388
Update README.md
markscamilleri Apr 19, 2021
30f9146
Update Makefile
markscamilleri Apr 19, 2021
b17ac97
Linting in README.md
markscamilleri Apr 19, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/
Expand Down
21 changes: 21 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,27 @@ E.g.
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

Expand Down