Skip to content

added information on Windows usage #9

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

added information on Windows usage #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
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 @@ -36,3 +36,24 @@ A Helm plugin that installs or upgrades raw Helm charts from GitHub
* `helm github upgrade happy-panda --repo [email protected]:kubernetes/charts.git --path stable/external-dns`
* `helm github upgrade happy-panda --repo [email protected]:coreos/alb-ingress-controller.git --ref 6d64984 --path alb-ingress-controller-helm`
* `helm github upgrade happy-panda --repo [email protected]:coreos/alb-ingress-controller.git --ref master --path alb-ingress-controller-helm -f alb-ingress-controller/values.yml --version 0.0.6`

### Windows Support

This plugin is written as a Bash script, and therefore not designed to run under Microsoft Windows.
[Git for Windows](https://gitforwindows.org/), however, bundles the so-called `Git Bash`. This
alternative shell comes bundled with many unix commands and a bash implementation.

In order to use this plugin with the `Git Bash` (**not** `cmd.exe` or `PowerShell`!), please modify
the `plugin.yml` file, and replace the line

```yaml
command: "$HELM_PLUGIN_DIR/github.sh"
```

with

```yaml
command: "bash $HELM_PLUGIN_DIR/github.sh"
```

You can do this either on your own fork of this plugin, or the installed version in `~/.helm/plugins`.