Skip to content

Commit b70810c

Browse files
Library Version 0.1.0 (#2)
* Library Chart 0.1.0
1 parent a452972 commit b70810c

File tree

18 files changed

+2661
-51
lines changed

18 files changed

+2661
-51
lines changed

.github/workflows/linter.yml

Lines changed: 12 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
#
2-
# Template based on origin https://github.com/helm/charts-repo-actions-demo/blob/master/.github/workflows/lint-test.yaml
2+
# Reference: https://github.com/helm/chart-testing-action
33
#
44
name: Helm Chart Linting and Testing
55
on: pull_request
66
jobs:
7-
8-
lint:
7+
chart-test:
98
runs-on: ubuntu-latest
109
steps:
1110
- name: Checkout
@@ -14,26 +13,20 @@ jobs:
1413
- name: Fetch history
1514
run: git fetch --prune --unshallow
1615

17-
- name: Run chart-testing (lint)
18-
uses: helm/[email protected]
16+
- name: Chart Linting
17+
id: lint
18+
uses: helm/[email protected]
1919
with:
20-
config: ct.yaml
2120
command: lint
22-
test:
23-
runs-on: ubuntu-latest
24-
needs: lint
25-
steps:
26-
- name: Checkout
27-
uses: actions/checkout@v2
28-
29-
- name: Fetch history
30-
run: git fetch --prune --unshallow
3121

3222
- name: Create kind cluster
33-
uses: helm/[email protected]
23+
uses: helm/[email protected]
24+
# Only build a kind cluster if there are chart changes to test.
25+
if: steps.lint.outputs.changed == 'true'
3426

35-
- name: Run chart-testing (install)
36-
uses: helm/[email protected]
27+
- name: Chart Installation
28+
uses: helm/[email protected]
29+
# Only test if there are any changes
30+
if: steps.lint.outputs.changed == 'true'
3731
with:
38-
config: ct.yaml
3932
command: install

.github/workflows/release.yml

Lines changed: 34 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -3,42 +3,53 @@ on:
33
push:
44
branches:
55
- master
6-
76
jobs:
8-
release:
7+
documentation:
98
runs-on: ubuntu-latest
9+
container:
10+
image: alpine
1011
steps:
12+
13+
- name: Install Dependencies
14+
run: |
15+
apk add jq git curl
1116
- name: Checkout
1217
uses: actions/checkout@v2
1318

1419
- name: Fetch history
1520
run: git fetch --prune --unshallow
1621

17-
- name: Helm Chart Publish
18-
uses: Kubernetli/helm-release-action@master
19-
#uses: Kubernetli/[email protected]
20-
with:
21-
token: ${{ secrets.GITHUB_TOKEN }}
22-
23-
changelog:
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
43+
release:
2444
runs-on: ubuntu-latest
25-
needs: release
2645
steps:
2746
- name: Checkout
2847
uses: actions/checkout@v2
29-
with:
30-
ref: 'master'
3148

32-
- name: Generate Changelog
33-
id: generate-changelog
34-
uses: heinrichreimer/[email protected]
49+
- name: Fetch history
50+
run: git fetch --prune --unshallow
51+
52+
- name: Helm Chart Publish
53+
uses: Kubernetli/helm-release-action@dev
3554
with:
3655
token: ${{ secrets.GITHUB_TOKEN }}
37-
38-
- name: Update Changelog
39-
run: |
40-
git config user.name "$GITHUB_ACTOR"
41-
git config user.email "[email protected]"
42-
git add CHANGELOG.md
43-
git commit -sam "Update Changelog"
44-
git push

CHANGELOG.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,9 @@ All submissions, including submissions by project members, require review. We us
3838
2. Review is done manually.
3939
3. Once review is done, the branch is merged into the master branch, where a Github action automatically creates a release on the GitHub repository. The new release is added to the index, laying in the gh-pages branch.
4040

41+
## Helm Docs
42+
43+
To have consistent README documentations for each chart we use the [helm-docs plugin](https://github.com/norwoodj/helm-docs). Make sure to write the chart README in a compatible format.
4144

4245
## Technical Requirements
4346

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11

2-
# Kubernetli Helm Repository
2+
# Buttahtoast Public Helm Repository
33

44
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
5+
[![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/buttahtoast)](https://artifacthub.io/packages/search?repo=buttahtoast)
56

67
## Usage
78

89
Adding the repository is as simple as that:
910

1011
```
11-
helm repo add kubernetli https://kubernetli.github.io/helm-charts
12+
helm repo add buttahtoast https://buttahtoast.github.io/helm-charts/
1213
```
1314

1415
## Contributing

charts/library/.helmignore

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Patterns to ignore when building packages.
2+
# This supports shell glob matching, relative path matching, and
3+
# negation (prefixed with !). Only one pattern per line.
4+
.DS_Store
5+
# Common VCS dirs
6+
.git/
7+
.gitignore
8+
.bzr/
9+
.bzrignore
10+
.hg/
11+
.hgignore
12+
.svn/
13+
# Common backup files
14+
*.swp
15+
*.bak
16+
*.tmp
17+
*.orig
18+
*~
19+
# Various IDEs
20+
.project
21+
.idea/
22+
*.tmproj
23+
.vscode/

charts/library/Chart.yaml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
apiVersion: v2
2+
name: library
3+
description: Buttahtoast Helm Library
4+
type: library
5+
version: 0.1.0
6+
appVersion: 0.1.0
7+
home: https://github.com/buttahtoast/helm-charts/tree/master/charts/library
8+
keywords:
9+
- library
10+
maintainers:
11+
- name: oliverbaehler
12+

0 commit comments

Comments
 (0)