Skip to content

Commit 07afc6c

Browse files
committed
Document the minimal install
1 parent 0b4931a commit 07afc6c

File tree

5 files changed

+28
-4
lines changed

5 files changed

+28
-4
lines changed

.github/workflows/build.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,4 @@ jobs:
3333
version: latest
3434
args: release --snapshot --rm-dist
3535
- name: Test Binary is Runnable
36-
run: "dist/helm-dashboard_linux_amd64_v1/helm-dashboard --help"
36+
run: "dist/helm-dashboard_linux_amd64_v1/helm-dashboard --help"

.github/workflows/release.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,5 @@ jobs:
2626
args: release --rm-dist
2727
env:
2828
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
29+
- name: Test Binary Versions
30+
run: "dist/helm-dashboard_linux_amd64_v1/helm-dashboard --help"

.goreleaser.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
builds:
44
- main: ./main.go
55
binary: helm-dashboard
6-
ldflags: -s -w -X github.com/komodorio/helm-dashboard/main.version={{.Version}} -X github.com/komodorio/helm-dashboard/main.commit={{.Commit}}
6+
ldflags: -s -w -X main.version={{.Version}} -X main.version={{.Version}} -X main.version={{.Version}} -X main.date={{.Date}}
77
goos:
88
- windows
99
- darwin

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,27 @@
22

33
A simplified way of working with Helm.
44

5+
## Local Testing
6+
7+
Until we make our repo public, we have to use a custom way to install the plugin.
8+
9+
To install, checkout the source code and run from source dir:
10+
```shell
11+
helm plugin install .
12+
```
13+
14+
There is a need to build binary for plugin to function, run:
15+
```shell
16+
go build -o bin/dashboard .
17+
```
18+
19+
Local install of plugin just creates a symlink, so making the changes and rebuilding the binary would not require reinstall of a plugin.
20+
21+
To uninstall, run:
22+
```shell
23+
helm plugin uninstall dashboard
24+
```
25+
526

627
## Roadmap
728

main.go

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,12 @@ import (
1010

1111
var (
1212
version = "dev"
13-
commit = "dev"
13+
commit = "none"
14+
date = "unknown"
1415
)
1516

1617
func main() {
17-
log.Infof("Helm Dashboard by Komodor, version %s (%s)", version, commit)
18+
log.Infof("Helm Dashboard by Komodor, version %s (%s @ %s)", version, commit, date)
1819

1920
if len(os.Args) > 1 {
2021
os.Exit(0)

0 commit comments

Comments
 (0)