feat: Update CI to run helm-docs and fail if changes exist (#160)

* add script to check diff for chart README

* add steps to helm job to run helm-docs and check the diff

* make script executable

* fix path to readme

* fix path to readme

* fix path to readme

* fix path to readme

* ran helm-docs

.github/workflows/ci.yml

@@ -17,6 +17,12 @@ jobs:
           CHART_LOCATION: ./charts/bindplane
           CHART_VALUES: ./charts/bindplane/values.yaml
 
+      - name: Helm Docs
+        uses: losisin/helm-docs-github-action@v1
+
+      - name: Helm Docs Check
+        run: .github/workflows/scripts/check-helm-docs.sh
+
   integration:
     runs-on: ubuntu-20.04
     strategy:

.github/workflows/scripts/check-helm-docs.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+set -e
+
+if ! git diff --exit-code --quiet 'charts/bindplane/README.md'; then
+    echo "ERROR: Uncommitted helm doc changes detected. Please commit your changes before running this script."
+    exit 1
+fi

charts/bindplane/README.md

@@ -1,6 +1,6 @@
 # bindplane
 
-![Version: 1.15.1](https://img.shields.io/badge/Version-1.15.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.72.0](https://img.shields.io/badge/AppVersion-1.72.0-informational?style=flat-square)
+![Version: 1.16.0](https://img.shields.io/badge/Version-1.16.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.72.0](https://img.shields.io/badge/AppVersion-1.72.0-informational?style=flat-square)
 
 BindPlane OP is an observability pipeline.
 
@@ -148,6 +148,11 @@ BindPlane OP is an observability pipeline.
 | resources.requests.memory | string | `"1000Mi"` | Memory request. |
 | service.annotations | object | `{}` | Custom annotations which will be added to the service object. Useful for specifying things such as `cloud.google.com/backend-config`. |
 | tolerations | object | `{}` | The Pod's tolerations |
+| topologySpreadConstraints.bindplane | list | `[]` | spec.template.spec.topologySpreadConstraints on the BindPlane deployment pods. |
+| topologySpreadConstraints.jobs | list | `[]` | This is for configuring spec.template.spec.topologySpreadConstraints on the BindPlane Jobs pod. The jobs pod is a single pod deployment. |
+| topologySpreadConstraints.nats | list | `[]` | This is for configuring spec.template.spec.topologySpreadConstraints on the BindPlane NATS statefulset pods, if NATS is enabled. |
+| topologySpreadConstraints.prometheus | list | `[]` | This is for configuring spec.template.spec.topologySpreadConstraints on the BindPlane Prometheus pod. The Prometheus pod is a single pod deployment. |
+| topologySpreadConstraints.transform_agent | list | `[]` | This is for configuring spec.template.spec.topologySpreadConstraints on the BindPlane transform agent pod. The transform agent pod is a single pod deployment. |
 | trace.otlp.endpoint | string | `""` | Endpoint of the OTLP trace receiver. Should be in the form of ip:port or host:port. |
 | trace.otlp.insecure | bool | `false` | Set to `true` to disable TLS. Set to false if TLS is in use by the OTLP trace receiver. |
 | trace.otlp.samplingRate | string | `"1"` | Sampling rate between 0 and 1. 1 being 100% of traces are sent. |
@@ -157,4 +162,4 @@ BindPlane OP is an observability pipeline.
 | transform_agent.tag | string | `""` | Transform Agent Image tag to use. Defaults to latest. |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
+Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)