add workflow to generate README.md

Signed-off-by: Tom Hayward <[email protected]>

.github/workflows/lint-test.yml

@@ -35,11 +35,6 @@ jobs:
       - name: Run chart-testing (lint)
         run: ct lint --config ct.yaml
 
-      - name: Updated README.md
-        run: |
-          make README.md
-          git diff --exit-code -- README.md
-
       - name: Create kind cluster
         uses: helm/[email protected]
 

.github/workflows/readme.yml

@@ -0,0 +1,30 @@
+name: Generate README.md
+
+on:
+  push:
+    branches-ignore:
+      - main
+      - master
+    paths:
+      - 'README.md*'
+      - values.yaml
+  pull_request:
+
+jobs:
+  generate:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Generate README.md
+        run: |
+          make README.md
+
+      - name: Commit changes
+        uses: EndBug/add-and-commit@v7
+        with:
+          add: README.md
+          default_author: github_actions
+          message: generate README.md
+          signoff: true

README.md.gotmpl

@@ -1,3 +1,5 @@
+<!-- README.md is a generated file. Make any changes in README.md.gotmpl or values.yaml. -->
+
 {{ template "chart.header" . }}
 {{ template "chart.deprecationWarning" . }}