Skip to content
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

Update documentation about the fundations of this action #57

Merged
merged 1 commit into from
Feb 19, 2023
Merged

Update documentation about the fundations of this action #57

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
24 changes: 9 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Helm 3 Github Action
# Helm Github Action

Slim wrapper around [helm3](https://github.com/helm/helm) Docker image
Runs given Helm/shell commands after ensuring Helm and kubectl are installed or pull in it's own.

![Example output showing this action in action](images/output.png)

Expand All @@ -10,7 +10,7 @@ This action supports the following options.

### exec

The command to execute inside the Docker image.
The shell commands to run.

* *Required*: `Yes`
* *Type*: `string`
Expand Down Expand Up @@ -44,17 +44,11 @@ jobs:
deployment:
runs-on: 'ubuntu-latest'
steps:
- uses: actions/checkout@v1
- name: Prep helm chart
run: |
mv ./.helm/app/Chart.yaml ./.helm/app/Chart.old.yaml &&
cat ./.helm/app/Chart.old.yaml | grep -v appVersion > ./.helm/app/Chart.yaml &&
echo -e "\r\nappVersion: v${GITHUB_REF##*/}\r\n" >> ./.helm/app/Chart.yaml &&
cat ./.helm/app/Chart.yaml
- uses: actions/checkout@v3
- name: Deploy
uses: WyriHaximus/github-action-helm3@v2
uses: WyriHaximus/github-action-helm3@v3
with:
exec: helm upgrade APP_NAME ./.helm/app/ --install --wait --atomic --namespace=APP_NAMESPACE --set=app.name=APP_NAME --values=./.helm/app/values.yaml
exec: helm upgrade APP_NAME ./.helm/app/ --install --wait --atomic --namespace=APP_NAMESPACE --values=./.helm/app/values.yaml
kubeconfig: '${{ secrets.KUBECONFIG }}'
```

Expand All @@ -68,16 +62,16 @@ jobs:
lint-helm:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- uses: actions/checkout@v3
- name: Lint Helm
uses: WyriHaximus/github-action-helm3@v2
uses: WyriHaximus/github-action-helm3@v3
with:
exec: helm lint ./.helm/app/
```

## License ##

Copyright 2020 [Cees-Jan Kiewiet](http://wyrihaximus.net/)
Copyright 2023 [Cees-Jan Kiewiet](http://wyrihaximus.net/)

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
Expand Down