Skip to content

Commit

Permalink
feat: auto helm-doc and update node-red (#308)
Browse files Browse the repository at this point in the history
Signed-off-by: Engin Diri <engin.diri@ediri.de>
  • Loading branch information
dirien authored Dec 29, 2023
1 parent f282ce0 commit bb44016
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 6 deletions.
3 changes: 2 additions & 1 deletion .github/workflows/publish.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@ on:
- main
paths:
- "charts/**"
- "!charts/**/README.md"
env:
HELM_DOCS_VERSION: "1.11.0"
HELM_DOCS_VERSION: "1.12.0"

permissions: read-all

Expand Down
40 changes: 40 additions & 0 deletions .github/workflows/update-docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: Update Documentation

on:
workflow_run:
workflows:
- "chart-publish"
types:
- completed

permissions: read-all

jobs:
documentation-update:
runs-on: ubuntu-latest
if: ${{github.event.workflow_run.conclusion == 'success'}}
env:
HELM_DOCS_VERSION: '1.12.0'

steps:
- name: Checkout repository
uses: actions/checkout@v2

- name: Install helm-docs
run: |
cd /tmp
wget https://github.com/norwoodj/helm-docs/releases/download/v${{env.HELM_DOCS_VERSION}}/helm-docs_${{env.HELM_DOCS_VERSION}}_Linux_x86_64.tar.gz
tar -xvf helm-docs_${{env.HELM_DOCS_VERSION}}_Linux_x86_64.tar.gz
sudo mv helm-docs /usr/local/sbin
- name: Run helm-docs
run: |
helm-docs -t README.md.gotmpl -o README.md -b for-the-badge
- name: Commit changes
run: |
git config --local user.email "action@github.com"
git config --local user.name "GitHub Action"
git add README.md
git commit -m "Update documentation via helm-docs"
git push
9 changes: 4 additions & 5 deletions charts/node-red/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ icon: https://nodered.org/about/resources/media/node-red-icon-2.png

type: application

version: 0.28.2
appVersion: 3.0.2
version: 0.29.0
appVersion: 3.1.3

keywords:
- node-red
Expand All @@ -29,11 +29,10 @@ maintainers:
annotations:
artifacthub.io/containsSecurityUpdates: "false"
artifacthub.io/changes: |
- add ability to tweak Deployment's liveness/readiness probes
- add ability to tweak Deployment's terminationGracePeriodSeconds
- change node-red version to 3.1.3
artifacthub.io/images: |
- name: node-red
image: docker.io/nodered/node-red:3.0.2
image: docker.io/nodered/node-red:3.1.3
- name: node-red-sidecar
image: quay.io/kiwigrid/k8s-sidecar:1.25.3
artifacthub.io/license: Apache-2.0
Expand Down

0 comments on commit bb44016

Please sign in to comment.