Skip to content

Commit 5dea753

Browse files
authored
Updated Readme
1 parent 343c9f7 commit 5dea753

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

README.md

+16-2
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ Following inputs can be used as `step.with` keys
1717
| `aws-region` | String | AWS region to use. This must match the region your desired cluster lies in. |
1818
| `cluster-name` | String | The name of the desired cluster. |
1919
| `cluster-role-arn` | String | If you wish to assume an admin role, provide the role arn here to login as. |
20+
| `action` | String | Determines if we `install` or `uninstall` the chart. (Optional, Defaults to `install`)
2021
| `config-files` | String | Comma separated list of helm values files. |
2122
| `namespace` | String | Kubernetes namespace to use. Will create if it does not exist |
2223
| `values` | String | Comma separated list of value set for helms. e.x:`key1=value1,key2=value2` |
@@ -32,7 +33,7 @@ Following inputs can be used as `step.with` keys
3233
## Example usage
3334

3435
```yaml
35-
uses: bitovi/[email protected].3
36+
uses: bitovi/[email protected].4
3637
with:
3738
aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
3839
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
@@ -48,7 +49,7 @@ with:
4849
## Example 2
4950
```yaml
5051
- name: Deploy Helm
51-
uses: bitovi/[email protected].3
52+
uses: bitovi/[email protected].4
5253
with:
5354
aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
5455
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
@@ -63,6 +64,19 @@ with:
6364
atomic: true
6465
```
6566
67+
## Example Uninstall
68+
69+
```yaml
70+
uses: bitovi/[email protected]
71+
with:
72+
aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
73+
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
74+
aws-region: us-west-2
75+
action: uninstall
76+
cluster-name: mycluster
77+
namespace: dev
78+
name: release_name
79+
```
6680
6781
## Contributing
6882
We would love for you to contribute to [`bitovi/github-actions-deploy-eks-helm`](https://github.com/bitovi/github-actions-deploy-eks-helm). [Issues](https://github.com/bitovi/github-actions-deploy-eks-helm/issues) and [Pull Requests](https://github.com/bitovi/github-actions-deploy-eks-helm/pulls) are welcome!

0 commit comments

Comments
 (0)