Skip to content

Commit ce88e6c

Browse files
[housekeeping] Documentation Workflow (#12)
* Documentation Workflow Signed-off-by: Oliver Bähler <[email protected]>
1 parent d4be2a5 commit ce88e6c

File tree

4 files changed

+40
-38
lines changed

4 files changed

+40
-38
lines changed

.github/workflows/linter.yml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,41 @@ jobs:
3030
if: steps.lint.outputs.changed == 'true'
3131
with:
3232
command: install
33+
34+
documentation:
35+
runs-on: ubuntu-latest
36+
needs:
37+
- chart-test
38+
container:
39+
image: alpine
40+
steps:
41+
- name: Install Dependencies
42+
run: |
43+
apk add jq git curl
44+
- name: Checkout
45+
uses: actions/checkout@v2
46+
47+
- name: Fetch history
48+
run: git fetch --prune --unshallow
49+
50+
- name: Install Helm Docs
51+
run: |
52+
curl -s -L -o /usr/local/bin/helm-docs.tar.gz "https://github.com/norwoodj/helm-docs/releases/download/$(curl --silent "https://api.github.com/repos/norwoodj/helm-docs/releases/latest" | jq -r .tag_name)/helm-docs_$(curl --silent "https://api.github.com/repos/norwoodj/helm-docs/releases/latest" | jq -r .tag_name | cut -d "v" -f2-)_Linux_x86_64.tar.gz"
53+
cd /usr/local/bin/ && tar xfv helm-docs.tar.gz
54+
chmod +x ./helm-docs
55+
- name: Update Documentation
56+
run: |
57+
git status
58+
CHARTS_ROOT="./charts"
59+
if [ -d "${CHARTS_ROOT}" ]; then
60+
## Generate Documentation
61+
helm-docs
62+
## Push Changes
63+
git config user.name "$GITHUB_ACTOR"
64+
git config user.email "[email protected]"
65+
git add -A
66+
git commit -sam "Update Documentation" || true
67+
git push || true
68+
else
69+
echo -e "\n\e[33m-- Root Direcoty not found: $CHART_ROOT\e[0m" && exit 0;
70+
fi

.github/workflows/release.yml

Lines changed: 0 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -4,42 +4,6 @@ on:
44
branches:
55
- master
66
jobs:
7-
documentation:
8-
runs-on: ubuntu-latest
9-
container:
10-
image: alpine
11-
steps:
12-
13-
- name: Install Dependencies
14-
run: |
15-
apk add jq git curl
16-
- name: Checkout
17-
uses: actions/checkout@v2
18-
19-
- name: Fetch history
20-
run: git fetch --prune --unshallow
21-
22-
- name: Install Helm Docs
23-
run: |
24-
curl -s -L -o /usr/local/bin/helm-docs.tar.gz "https://github.com/norwoodj/helm-docs/releases/download/$(curl --silent "https://api.github.com/repos/norwoodj/helm-docs/releases/latest" | jq -r .tag_name)/helm-docs_$(curl --silent "https://api.github.com/repos/norwoodj/helm-docs/releases/latest" | jq -r .tag_name | cut -d "v" -f2-)_Linux_x86_64.tar.gz"
25-
cd /usr/local/bin/ && tar xfv helm-docs.tar.gz
26-
chmod +x ./helm-docs
27-
- name: Update Documentation
28-
run: |
29-
git status
30-
CHARTS_ROOT="./charts"
31-
if [ -d "${CHARTS_ROOT}" ]; then
32-
## Generate Documentation
33-
helm-docs
34-
## Push Changes
35-
git config user.name "$GITHUB_ACTOR"
36-
git config user.email "[email protected]"
37-
git add -A
38-
git commit -sam "Update Documentation" || true
39-
git push || true
40-
else
41-
echo -e "\n\e[33m-- Root Direcoty not found: $CHART_ROOT\e[0m" && exit 0;
42-
fi
437
release:
448
runs-on: ubuntu-latest
459
steps:

charts/tavern/Chart.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ apiVersion: v2
22
name: tavern
33
description: "Unofficial Tavern Helm Chart"
44
type: application
5-
version: 0.2.0
5+
version: 0.2.1
66
appVersion: 1.0.3
77
home: "https://tavern.readthedocs.io/en/latest/"
88
icon: "https://tavern.readthedocs.io/en/latest/_static/icon.png"

charts/tavern/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Tavern
22

3-
![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
3+
![Version: 0.2.1](https://img.shields.io/badge/Version-0.2.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
44

55
Unofficial Tavern Helm Chart
66

0 commit comments

Comments
 (0)