📝 check for updated docs in pipeline (#98)

Using `helm-docs` (https://github.com/norwoodj/helm-docs)

Author: DrPsychick

.github/workflows/docs.yaml

@@ -0,0 +1,33 @@
+name: Check docs
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+      types: [opened, reopened, synchronize]
+      paths:
+          - "charts/**"
+          - ".github/workflows/**"
+
+jobs:
+  test:
+    name: Check for updated Helm Chart docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Go
+        uses: actions/setup-go@v5
+
+      - name: Install helm-docs
+        run: |
+          go install github.com/norwoodj/helm-docs/cmd/helm-docs@latest
+
+      - name: Check if README is missing updates
+        run: |
+          helm-docs
+          git diff --exit-code charts/athens-proxy/README.md

charts/athens-proxy/README.md

@@ -1,6 +1,6 @@
 # Athens Proxy Helm Chart: athens-proxy
 
-![Version: 0.14.0](https://img.shields.io/badge/Version-0.14.0-informational?style=flat-square) ![AppVersion: v0.15.1](https://img.shields.io/badge/AppVersion-v0.15.1-informational?style=flat-square)
+![Version: 0.14.4](https://img.shields.io/badge/Version-0.14.4-informational?style=flat-square) ![AppVersion: v0.15.4](https://img.shields.io/badge/AppVersion-v0.15.4-informational?style=flat-square)
 
 ## What is Athens?
 
@@ -10,7 +10,7 @@ Athens provides a repository for [Go Modules](https://github.com/golang/go/wiki/
 
 ## Prerequisites
 
-Kubernetes: `>= 1.19`
+Kubernetes: `>= 1.19-0`
 
 ## Requirements
 
@@ -86,6 +86,10 @@ This will deploy a single Athens instance in the `athens` namespace with `disk`
 | netrc.existingSecret | string | `"netrcsecret"` | Secret name, containing the '.netrc' file |
 | nodeSelector | object | `{}` | see https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling |
 | priorityClassName | string | `""` | Priority class for pod scheduling. see API reference: https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/#priorityclass |
+| readinessProbe.failureThreshold | int | `3` |  |
+| readinessProbe.periodSeconds | int | `10` |  |
+| readinessProbe.successThreshold | int | `1` |  |
+| readinessProbe.timeoutSeconds | int | `1` |  |
 | replicaCount | int | `1` | Set the number of athens-proxy replicas, unless autoscaling is enabled |
 | resources | object | `{}` | Define resources for athens pods. see https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#resources |
 | securityContext | object | `{}` | Container security context configuration. see API reference: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#securitycontext-v1-core. This will override the `image.runAsNonRoot` settings in the specified container if `runAsUser` or `runAsGroup` are set |

charts/athens-proxy/README.md.gotmpl

@@ -1,4 +1,4 @@
-{{- /* run `helm-docs` to generate README.md */ -}}
+{{- /* run `helm-docs` (github.com/norwoodj/helm-docs) to generate README.md */ -}}
 
 # Athens Proxy Helm Chart: {{ template "chart.name" . }}