check for updated README.md in CI (#183)

* check for updated README.md in CI Signed-off-by: Tom Hayward <thayward@infoblox.com> * add missing values Signed-off-by: Tom Hayward <thayward@infoblox.com> * generate readme Signed-off-by: Tom Hayward <thayward@infoblox.com>
cortexproject · Jul 30, 2021 · 3371ca7 · 3371ca7
1 parent f0b2431
commit 3371ca7
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 5 deletions.
diff --git a/.github/workflows/lint-test.yml b/.github/workflows/lint-test.yml
@@ -35,6 +35,11 @@ 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/kind-action@v1.2.0
 

diff --git a/Makefile b/Makefile
@@ -0,0 +1,3 @@
+.PHONY: README.md
+README.md:
+	docker run --rm --volume "$(shell pwd):/helm-docs" -u $(shell id -u) jnorwood/helm-docs:latest
diff --git a/README.md b/README.md
@@ -1,6 +1,8 @@
+<!-- README.md is a generated file. Make any changes in README.md.gotmpl or values.yaml. -->
+
 # cortex
 
-![Version: 0.5.0](https://img.shields.io/badge/Version-0.5.0-informational?style=flat-square) ![AppVersion: v1.9.0](https://img.shields.io/badge/AppVersion-v1.9.0-informational?style=flat-square)
+![Version: 0.6.0](https://img.shields.io/badge/Version-0.6.0-informational?style=flat-square) ![AppVersion: v1.9.0](https://img.shields.io/badge/AppVersion-v1.9.0-informational?style=flat-square)
 
 Horizontally scalable, highly available, multi-tenant, long term Prometheus.
 
@@ -143,7 +145,7 @@ metadata:
   labels:
     cortex_alertmanager: "1"
   name: alertmanager-example-config
-data: 
+data:
   fake.yaml: |-
     global:
       resolve_timeout: 5m
@@ -296,9 +298,9 @@ Kubernetes: `^1.19.0-0`
 | compactor.strategy.type | string | `"RollingUpdate"` |  |
 | compactor.terminationGracePeriodSeconds | int | `240` |  |
 | compactor.tolerations | list | `[]` |  |
+| config.alertmanager.enable_api | bool | `false` | Enable the experimental alertmanager config api. |
 | config.alertmanager.external_url | string | `"/api/prom/alertmanager"` |  |
-| config.alertmanager.enable_api | bool | `false` | Enable the experimental alertmanager config api.  |
-| config.alertmanager.storage | object | {} | Type of backend to use to store alertmanager configs. Supported values are: "configdb", "gcs", "s3", "local". refer to: https://cortexmetrics.io/docs/configuration/configuration-file/#alertmanager_config |
+| config.alertmanager.storage | object | `{}` | Type of backend to use to store alertmanager configs. Supported values are: "configdb", "gcs", "s3", "local". refer to: https://cortexmetrics.io/docs/configuration/configuration-file/#alertmanager_config |
 | config.api.prometheus_http_prefix | string | `"/prometheus"` |  |
 | config.api.response_compression_enabled | bool | `true` |  |
 | config.auth_enabled | bool | `false` |  |
@@ -334,7 +336,7 @@ Kubernetes: `^1.19.0-0`
 | config.query_range.split_queries_by_interval | string | `"24h"` |  |
 | config.ruler.enable_alertmanager_discovery | bool | `false` |  |
 | config.ruler.enable_api | bool | `false` | Enable the experimental ruler config api. |
-| config.ruler.storage | object | {} | Method to use for backend rule storage (configdb, azure, gcs, s3, swift, local) refer to https://cortexmetrics.io/docs/configuration/configuration-file/#ruler_config|
+| config.ruler.storage | object | `{}` | Method to use for backend rule storage (configdb, azure, gcs, s3, swift, local) refer to https://cortexmetrics.io/docs/configuration/configuration-file/#ruler_config |
 | config.schema.configs[0].chunks.period | string | `"168h"` |  |
 | config.schema.configs[0].chunks.prefix | string | `"chunks_"` |  |
 | config.schema.configs[0].from | string | `"2020-11-01"` |  |

diff --git a/README.md.gotmpl b/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" . }}
 

diff --git a/values.yaml b/values.yaml
@@ -162,8 +162,16 @@ config:
           timeout: 1s
   ruler:
     enable_alertmanager_discovery: false
+    # -- Enable the experimental ruler config api.
+    enable_api: false
+    # -- Method to use for backend rule storage (configdb, azure, gcs, s3, swift, local) refer to https://cortexmetrics.io/docs/configuration/configuration-file/#ruler_config
+    storage: {}
   alertmanager:
+    # -- Enable the experimental alertmanager config api.
+    enable_api: false
     external_url: '/api/prom/alertmanager'
+    # -- Type of backend to use to store alertmanager configs. Supported values are: "configdb", "gcs", "s3", "local". refer to: https://cortexmetrics.io/docs/configuration/configuration-file/#alertmanager_config
+    storage: {}
   frontend:
     #  max_outstanding_per_tenant: 1000
     log_queries_longer_than: 10s