Skip to content

check for updated README.md in CI #183

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 30, 2021
Merged

check for updated README.md in CI #183

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
efc7bd8
check for updated README.md in CI
kd7lxl Jul 28, 2021
0593ac1
add missing values
kd7lxl Jul 29, 2021
7911826
generate readme
kd7lxl Jul 29, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/workflows/lint-test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/[email protected]

Expand Down
3 changes: 3 additions & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
12 changes: 7 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.

Expand Down Expand Up @@ -143,7 +145,7 @@ metadata:
labels:
cortex_alertmanager: "1"
name: alertmanager-example-config
data:
data:
fake.yaml: |-
global:
resolve_timeout: 5m
Expand Down Expand Up @@ -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` | |
Expand Down Expand Up @@ -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"` | |
Expand Down
2 changes: 2 additions & 0 deletions README.md.gotmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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" . }}

Expand Down
8 changes: 8 additions & 0 deletions values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down