Skip to content

Commit

Permalink
Document the minimal install
Browse files Browse the repository at this point in the history
  • Loading branch information
undera committed Aug 23, 2022
1 parent 0b4931a commit 07afc6c
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ jobs:
version: latest
args: release --snapshot --rm-dist
- name: Test Binary is Runnable
run: "dist/helm-dashboard_linux_amd64_v1/helm-dashboard --help"
run: "dist/helm-dashboard_linux_amd64_v1/helm-dashboard --help"
2 changes: 2 additions & 0 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,5 @@ jobs:
args: release --rm-dist
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Test Binary Versions
run: "dist/helm-dashboard_linux_amd64_v1/helm-dashboard --help"
2 changes: 1 addition & 1 deletion .goreleaser.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
builds:
- main: ./main.go
binary: helm-dashboard
ldflags: -s -w -X github.com/komodorio/helm-dashboard/main.version={{.Version}} -X github.com/komodorio/helm-dashboard/main.commit={{.Commit}}
ldflags: -s -w -X main.version={{.Version}} -X main.version={{.Version}} -X main.version={{.Version}} -X main.date={{.Date}}
goos:
- windows
- darwin
Expand Down
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,27 @@

A simplified way of working with Helm.

## Local Testing

Until we make our repo public, we have to use a custom way to install the plugin.

To install, checkout the source code and run from source dir:
```shell
helm plugin install .
```

There is a need to build binary for plugin to function, run:
```shell
go build -o bin/dashboard .
```

Local install of plugin just creates a symlink, so making the changes and rebuilding the binary would not require reinstall of a plugin.

To uninstall, run:
```shell
helm plugin uninstall dashboard
```


## Roadmap

Expand Down
5 changes: 3 additions & 2 deletions main.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,12 @@ import (

var (
version = "dev"
commit = "dev"
commit = "none"
date = "unknown"
)

func main() {
log.Infof("Helm Dashboard by Komodor, version %s (%s)", version, commit)
log.Infof("Helm Dashboard by Komodor, version %s (%s @ %s)", version, commit, date)

if len(os.Args) > 1 {
os.Exit(0)
Expand Down

0 comments on commit 07afc6c

Please sign in to comment.