Document the minimal install

This commit is contained in:
Andrey Pohilko
2022-08-23 10:01:14 +03:00
parent 0b4931a73a
commit 07afc6c6ef
5 changed files with 28 additions and 4 deletions

View File

@@ -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"

View File

@@ -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

View File

@@ -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

View File

@@ -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)