From 22ac3ce88d0a3728ef2c8930ddd69f811b747e70 Mon Sep 17 00:00:00 2001 From: Aarnav Tale Date: Wed, 25 Jan 2023 00:51:07 -0500 Subject: [PATCH] chore: add license and update readme --- LICENSE | 21 +++++++++++++++++++++ README.md | 9 +++++++-- 2 files changed, 28 insertions(+), 2 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0a555ec --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 Aarnav Tale + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 2a0794a..f1b2a62 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,11 @@ # kubectl-action + GitHub Action to manage a K8s (Kubernetes) cluster using kubectl. -# Usage +## Usage + To use this action, add the following step to your GitHub Action workflow: + ```yaml - uses: tale/kubectl-action@v1 with: @@ -11,7 +14,8 @@ To use this action, add the following step to your GitHub Action workflow: Keep in mind that the action expects a base64 encoded string of your Kubernetes configuration. The simplest way to do that is to run `cat $HOME/.kube/config | base64` and save that output as an action secret. -It's also possible to specify the version of the [kubectl](https://kubernetes.io/docs/reference/kubectl/) CLI to use. The current default release used by this action is `v1.26.0`. +It's also possible to specify the version of the [kubectl](https://kubernetes.io/docs/reference/kubectl/) CLI to use. The current default release used by this action is the latest version. + ```yaml - uses: tale/kubectl-action@v1 with: @@ -20,6 +24,7 @@ It's also possible to specify the version of the [kubectl](https://kubernetes.io ``` Once you've completed this setup, you have direct access to the `kubectl` binary and command in the rest of your actions. Here's a full example to give you some inspiration: + ```yaml name: Kubectl Action