Skip to content

Commit 8febfce

Browse files
committed
update readme and add license
1 parent f2acca6 commit 8febfce

2 files changed

Lines changed: 29 additions & 6 deletions

File tree

license.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Copyright About Bits GmbH
2+
3+
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:
4+
5+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6+
7+
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.

readme.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,35 @@
11
# GitHub Actions Kubernetes
22

3-
A collection of GitHub actions for Kubernetes projects.
3+
A collection of GitHub actions for Kubernetes.
44

5-
## Example Playbook
5+
## Setup DigitalOcean
6+
Setup Digital-Ocean CLI and configure Kubernetes.
7+
8+
### Example
9+
10+
```yaml
11+
- uses: aboutbits/github-actions-kubernetes/setup-digital-ocean@v1
12+
with:
13+
cluster-name: ${{ env.TEST_CLUSTER_NAME }}
14+
digital-ocean-token: ${{ secrets.DIGITALOCEAN_TOKEN }}
15+
```
16+
17+
## Deploy to Kubernetes
18+
Deploy application to a Kubernetes Cluster. Requires Kubernetes to be configured first.
19+
20+
### Example
621
722
```yaml
8-
- name: Build code
9-
uses: aboutbits/github-actions-kubernetes/xxx@v1
23+
- uses: aboutbits/github-actions-kubernetes/deploy-to-kubernetes@v1
1024
with:
11-
xxx-version: ${{ env.NODE_VERSION }}
25+
environment: 'test'
26+
namespace-name: ${{ env.NAMESPACE_NAME }}
27+
deployment-name: ${{ env.DEPLOYMENT_NAME }}
1228
```
1329
1430
## Versioning
1531
16-
In order to have a verioning in place and working, create leightweight tags that point to the appropriate minor release versions.
32+
In order to have a versioning in place and working, create lightweight tags that point to the appropriate minor release versions.
1733
1834
Creating a new minor release:
1935

0 commit comments

Comments
 (0)