update helm (#227)

Signed-off-by: cpanato <[email protected]>

Author: cpanato

.github/workflows/check-helm-docs.yml

@@ -0,0 +1,29 @@
+name: Check Helm Docs
+
+on:
+  pull_request:
+    paths:
+      - "charts/**"
+
+jobs:
+  readme:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
+
+      - name: Run Helm Docs and check the outcome
+        run: |
+          make docs
+          exit_code=$(git diff --exit-code)
+          exit ${exit_code}
+
+      - name: Print a comment in case of failure
+        run: |
+          echo "The README.md files are not up to date.
+
+          Please, run \"make docs\" before pushing."
+          exit 1
+        if: |
+          failure() && github.event.pull_request.head.repo.full_name == github.repository

Makefile

@@ -1,5 +1,7 @@
 all:: lint test build
 
+DOCS_IMAGE_VERSION="v1.14.2"
+
 .PHONY: lint
 lint:
 	@echo ">> running golangci-lint"
@@ -13,3 +15,13 @@ test:
 .PHONY: build
 build:
 	go build -o github-actions-exporter .
+
+.PHONY: docs
+docs:
+	@docker run \
+	--rm \
+	--workdir=/helm-docs \
+	--volume "$$(pwd):/helm-docs" \
+	-u $$(id -u) \
+	jnorwood/helm-docs:$(DOCS_IMAGE_VERSION) \
+	helm-docs -c ./charts/$* -t ./README.md.gotmpl -o ./README.md

charts/github-exporter/Chart.yaml

@@ -1,8 +1,8 @@
 apiVersion: v1
 description: GitHub exporter
 name: github-exporter
-version: 0.2.1
-appVersion: 0.7.1
+version: 0.3.0
+appVersion: 0.8.0
 home: https://github.com/cpanato/github_actions_exporter
 maintainers:
   - name: cpanato

charts/github-exporter/README.md

@@ -0,0 +1,57 @@
+# github-exporter
+
+![Version: 0.3.0](https://img.shields.io/badge/Version-0.3.0-informational?style=flat-square) ![AppVersion: 0.8.0](https://img.shields.io/badge/AppVersion-0.8.0-informational?style=flat-square)
+
+GitHub exporter
+
+**Homepage:** <https://github.com/cpanato/github_actions_exporter>
+
+## Maintainers
+
+| Name | Email | Url |
+| ---- | ------ | --- |
+| cpanato |  |  |
+
+## Values
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| config.org | string | `""` |  |
+| config.pollSeconds | int | `30` |  |
+| deployment.affinity | object | `{}` |  |
+| deployment.image.digest | string | `"sha256:b0d50195686567de51b1ede25e2a6538719921f1a04a3cc763d89184ef86f22c"` |  |
+| deployment.image.pullPolicy | string | `"IfNotPresent"` |  |
+| deployment.image.repository | string | `"ghcr.io/cpanato/github_actions_exporter"` |  |
+| deployment.image.tag | string | `"v0.8.0"` |  |
+| deployment.nodeSelector | object | `{}` |  |
+| deployment.podAnnotations | object | `{}` |  |
+| deployment.podLabels | object | `{}` |  |
+| deployment.replicaCount | int | `1` |  |
+| deployment.resources | object | `{}` |  |
+| deployment.tolerations | list | `[]` |  |
+| fullnameOverride | string | `""` |  |
+| ingress.annotations | object | `{}` |  |
+| ingress.enabled | bool | `false` |  |
+| ingress.extraLabels | object | `{}` |  |
+| ingress.host | string | `nil` |  |
+| labels | object | `{}` |  |
+| nameOverride | string | `""` |  |
+| prometheus.gcpManagedPrometheus.enabled | bool | `false` |  |
+| prometheus.serviceMonitor.additionalLabels.app | string | `"github-exporter"` |  |
+| prometheus.serviceMonitor.enabled | bool | `false` |  |
+| prometheus.serviceMonitor.interval | string | `"5m"` |  |
+| prometheus.serviceMonitor.metricRelabelings | object | `{}` |  |
+| prometheus.serviceMonitor.namespace | string | `"monitoring"` |  |
+| prometheus.serviceMonitor.scrapeTimeout | string | `"2m"` |  |
+| secret.existingSecretName | string | `""` |  |
+| secret.githubToken | string | `""` |  |
+| secret.githubWebhookToken | string | `""` |  |
+| service.annotationsIngress | object | `{}` |  |
+| service.annotationsMetrics | object | `{}` |  |
+| service.extraLabels | object | `{}` |  |
+| service.portHttp | int | `8065` |  |
+| service.portMetrics | int | `9101` |  |
+| service.type | string | `"ClusterIP"` |  |
+
+----------------------------------------------
+Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)

charts/github-exporter/README.md.gotmpl

@@ -0,0 +1,37 @@
+{{ template "chart.header" . }}
+
+<!-- This README.md is generated. Please edit README.md.gotmpl -->
+
+{{ template "chart.deprecationWarning" . }}
+
+{{ template "chart.badgesSection" . }}
+
+{{ template "chart.description" . }}
+
+{{ template "chart.homepageLine" . }}
+'
+## Quick Installation
+
+To install the helm chart with default values run following command.
+The [Values](#Values) section describes the configuration options for this chart.
+
+```shell
+helm dependency update .
+helm install [RELEASE_NAME] .
+```
+
+## Uninstallation
+
+To uninstall the Helm chart run following command.
+
+```shell
+helm uninstall [RELEASE_NAME]
+```
+
+{{ template "chart.maintainersSection" . }}
+
+{{ template "chart.sourcesSection" . }}
+
+{{ template "chart.requirementsSection" . }}
+
+{{ template "chart.valuesSection" . }}

charts/github-exporter/values.yaml

@@ -19,8 +19,8 @@ deployment:
   replicaCount: 1
   image:
     repository: ghcr.io/cpanato/github_actions_exporter
-    tag: v0.7.1
-    digest: sha256:0f7baabf04af6d1417955ac110b7234f862eadf2015f9f90a5c43efc1f8f9a35
+    tag: v0.8.0
+    digest: sha256:b0d50195686567de51b1ede25e2a6538719921f1a04a3cc763d89184ef86f22c
     pullPolicy: IfNotPresent
 
   podLabels: {}