Skip to content

Commit befe16f

Browse files
alexmvalexmv
committed
github: Run prettier over generated helm-docs.
We bump the chart version to appease the linter.
1 parent a0f15d3 commit befe16f

File tree

4 files changed

+101
-88
lines changed

4 files changed

+101
-88
lines changed

‎.github/workflows/dockerfile.yaml‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,21 @@ jobs:
5252

5353
- name: Run helm-docs
5454
uses: losisin/helm-docs-github-action@v1
55+
56+
- name: Run prettier over the re-generated docs
57+
uses: creyD/[email protected]
5558
with:
56-
fail-on-diff: true
59+
prettier_options: --write kubernetes/chart/zulip/README.md
60+
no_commit: True
61+
62+
- name: Check for any diff
63+
run: |
64+
if ! git diff --exit-code; then
65+
echo "Changes found!"
66+
git status
67+
git diff
68+
exit 1
69+
fi
5770
5871
helm-test:
5972
runs-on: ubuntu-latest

‎kubernetes/chart/zulip/Chart.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ maintainers:
1010
## incremented each time you make changes to the chart and its
1111
## templates, including the app version. Versions are expected to
1212
## follow Semantic Versioning (https://semver.org/)
13-
version: 0.11.41
13+
version: 0.11.42
1414

1515
## This is the version number of the application being deployed. This
1616
## version number should be incremented each time you make changes to

‎kubernetes/chart/zulip/README.md‎

Lines changed: 85 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Zulip
22

3-
![Version: 0.11.41](https://img.shields.io/badge/Version-0.11.41-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 11.4-0](https://img.shields.io/badge/AppVersion-11.4--0-informational?style=flat-square)
3+
![Version: 0.11.42](https://img.shields.io/badge/Version-0.11.42-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 11.4-0](https://img.shields.io/badge/AppVersion-11.4--0-informational?style=flat-square)
44

55
[Zulip](https://zulip.com/) is an open source threaded team chat that helps teams stay productive and focused.
66

@@ -66,83 +66,83 @@ Now you're ready to follow [the installation instructions above](#installation).
6666

6767
## Values
6868

69-
| Key | Type | Default | Description |
70-
|-----|------|---------|-------------|
71-
| affinity | object | `{}` | |
72-
| fullnameOverride | string | `""` | |
73-
| global.security.allowInsecureImages | bool | `true` | |
74-
| image.pullPolicy | string | `"IfNotPresent"` | |
75-
| image.repository | string | `"zulip/docker-zulip"` | |
76-
| image.tag | string | `"11.4-0"` | |
77-
| imagePullSecrets | list | `[]` | |
78-
| ingress.annotations | object | `{}` | |
79-
| ingress.enabled | bool | `false` | |
80-
| ingress.hosts[0].host | string | `"zulip.example.com"` | |
81-
| ingress.hosts[0].paths[0].path | string | `"/"` | |
82-
| ingress.tls | list | `[]` | |
83-
| livenessProbe.enabled | bool | `true` | |
84-
| livenessProbe.failureThreshold | int | `3` | |
85-
| livenessProbe.initialDelaySeconds | int | `10` | |
86-
| livenessProbe.periodSeconds | int | `10` | |
87-
| livenessProbe.successThreshold | int | `1` | |
88-
| livenessProbe.timeoutSeconds | int | `5` | |
89-
| memcached.image.repository | string | `"bitnamilegacy/memcached"` | |
90-
| memcached.image.tag | string | `"latest"` | |
91-
| memcached.memcachedUsername | string | `"zulip@localhost"` | |
92-
| nameOverride | string | `""` | |
93-
| nodeSelector | object | `{}` | |
94-
| podAnnotations | object | `{}` | |
95-
| podLabels | object | `{}` | |
96-
| podSecurityContext | object | `{}` | |
97-
| postSetup.scripts | object | `{}` | |
98-
| postgresql.auth.database | string | `"zulip"` | |
99-
| postgresql.auth.username | string | `"zulip"` | |
100-
| postgresql.image.repository | string | `"zulip/zulip-postgresql"` | |
101-
| postgresql.image.tag | int | `14` | |
102-
| postgresql.primary.containerSecurityContext.readOnlyRootFilesystem | bool | `false` | |
103-
| postgresql.primary.containerSecurityContext.runAsGroup | int | `70` | |
104-
| postgresql.primary.containerSecurityContext.runAsUser | int | `70` | |
105-
| rabbitmq.auth.username | string | `"zulip"` | |
106-
| rabbitmq.image.repository | string | `"bitnamilegacy/rabbitmq"` | |
107-
| rabbitmq.image.tag | string | `"4.1.3"` | |
108-
| rabbitmq.persistence.enabled | bool | `false` | |
109-
| redis.architecture | string | `"standalone"` | |
110-
| redis.image.repository | string | `"bitnamilegacy/redis"` | |
111-
| redis.image.tag | string | `"latest"` | |
112-
| redis.master.persistence.enabled | bool | `false` | |
113-
| resources | object | `{}` | |
114-
| securityContext | object | `{}` | |
115-
| service.port | int | `80` | |
116-
| service.type | string | `"ClusterIP"` | |
117-
| serviceAccount.annotations | object | `{}` | |
118-
| serviceAccount.create | bool | `true` | |
119-
| serviceAccount.name | string | `""` | |
120-
| sidecars | list | `[]` | |
121-
| startupProbe.enabled | bool | `true` | |
122-
| startupProbe.failureThreshold | int | `30` | |
123-
| startupProbe.initialDelaySeconds | int | `10` | |
124-
| startupProbe.periodSeconds | int | `10` | |
125-
| startupProbe.successThreshold | int | `1` | |
126-
| startupProbe.timeoutSeconds | int | `5` | |
127-
| statefulSetAnnotations | object | `{}` | |
128-
| statefulSetLabels | object | `{}` | |
129-
| tolerations | list | `[]` | |
130-
| zulip.environment.DISABLE_HTTPS | bool | `true` | |
131-
| zulip.environment.SECRETS_email_password | string | `"123456789"` | |
132-
| zulip.environment.SETTING_EMAIL_HOST | string | `""` | |
133-
| zulip.environment.SETTING_EMAIL_HOST_USER | string | `"[email protected]"` | |
134-
| zulip.environment.SETTING_EMAIL_PORT | string | `"587"` | |
135-
| zulip.environment.SETTING_EMAIL_USE_SSL | string | `"False"` | |
136-
| zulip.environment.SETTING_EMAIL_USE_TLS | string | `"True"` | |
137-
| zulip.environment.SETTING_EXTERNAL_HOST | string | `"zulip.example.com"` | |
138-
| zulip.environment.SETTING_ZULIP_ADMINISTRATOR | string | `"[email protected]"` | |
139-
| zulip.environment.SSL_CERTIFICATE_GENERATION | string | `"self-signed"` | |
140-
| zulip.environment.TRUST_GATEWAY_IP | bool | `true` | |
141-
| zulip.environment.ZULIP_AUTH_BACKENDS | string | `"EmailAuthBackend"` | |
142-
| zulip.persistence.accessMode | string | `"ReadWriteOnce"` | |
143-
| zulip.persistence.enabled | bool | `true` | |
144-
| zulip.persistence.size | string | `"10Gi"` | |
145-
| zulip.persistence.storageClass | string | `nil` | |
69+
| Key | Type | Default | Description |
70+
| ------------------------------------------------------------------ | ------ | --------------------------- | ----------- |
71+
| affinity | object | `{}` | |
72+
| fullnameOverride | string | `""` | |
73+
| global.security.allowInsecureImages | bool | `true` | |
74+
| image.pullPolicy | string | `"IfNotPresent"` | |
75+
| image.repository | string | `"zulip/docker-zulip"` | |
76+
| image.tag | string | `"11.4-0"` | |
77+
| imagePullSecrets | list | `[]` | |
78+
| ingress.annotations | object | `{}` | |
79+
| ingress.enabled | bool | `false` | |
80+
| ingress.hosts[0].host | string | `"zulip.example.com"` | |
81+
| ingress.hosts[0].paths[0].path | string | `"/"` | |
82+
| ingress.tls | list | `[]` | |
83+
| livenessProbe.enabled | bool | `true` | |
84+
| livenessProbe.failureThreshold | int | `3` | |
85+
| livenessProbe.initialDelaySeconds | int | `10` | |
86+
| livenessProbe.periodSeconds | int | `10` | |
87+
| livenessProbe.successThreshold | int | `1` | |
88+
| livenessProbe.timeoutSeconds | int | `5` | |
89+
| memcached.image.repository | string | `"bitnamilegacy/memcached"` | |
90+
| memcached.image.tag | string | `"latest"` | |
91+
| memcached.memcachedUsername | string | `"zulip@localhost"` | |
92+
| nameOverride | string | `""` | |
93+
| nodeSelector | object | `{}` | |
94+
| podAnnotations | object | `{}` | |
95+
| podLabels | object | `{}` | |
96+
| podSecurityContext | object | `{}` | |
97+
| postSetup.scripts | object | `{}` | |
98+
| postgresql.auth.database | string | `"zulip"` | |
99+
| postgresql.auth.username | string | `"zulip"` | |
100+
| postgresql.image.repository | string | `"zulip/zulip-postgresql"` | |
101+
| postgresql.image.tag | int | `14` | |
102+
| postgresql.primary.containerSecurityContext.readOnlyRootFilesystem | bool | `false` | |
103+
| postgresql.primary.containerSecurityContext.runAsGroup | int | `70` | |
104+
| postgresql.primary.containerSecurityContext.runAsUser | int | `70` | |
105+
| rabbitmq.auth.username | string | `"zulip"` | |
106+
| rabbitmq.image.repository | string | `"bitnamilegacy/rabbitmq"` | |
107+
| rabbitmq.image.tag | string | `"4.1.3"` | |
108+
| rabbitmq.persistence.enabled | bool | `false` | |
109+
| redis.architecture | string | `"standalone"` | |
110+
| redis.image.repository | string | `"bitnamilegacy/redis"` | |
111+
| redis.image.tag | string | `"latest"` | |
112+
| redis.master.persistence.enabled | bool | `false` | |
113+
| resources | object | `{}` | |
114+
| securityContext | object | `{}` | |
115+
| service.port | int | `80` | |
116+
| service.type | string | `"ClusterIP"` | |
117+
| serviceAccount.annotations | object | `{}` | |
118+
| serviceAccount.create | bool | `true` | |
119+
| serviceAccount.name | string | `""` | |
120+
| sidecars | list | `[]` | |
121+
| startupProbe.enabled | bool | `true` | |
122+
| startupProbe.failureThreshold | int | `30` | |
123+
| startupProbe.initialDelaySeconds | int | `10` | |
124+
| startupProbe.periodSeconds | int | `10` | |
125+
| startupProbe.successThreshold | int | `1` | |
126+
| startupProbe.timeoutSeconds | int | `5` | |
127+
| statefulSetAnnotations | object | `{}` | |
128+
| statefulSetLabels | object | `{}` | |
129+
| tolerations | list | `[]` | |
130+
| zulip.environment.DISABLE_HTTPS | bool | `true` | |
131+
| zulip.environment.SECRETS_email_password | string | `"123456789"` | |
132+
| zulip.environment.SETTING_EMAIL_HOST | string | `""` | |
133+
| zulip.environment.SETTING_EMAIL_HOST_USER | string | `"[email protected]"` | |
134+
| zulip.environment.SETTING_EMAIL_PORT | string | `"587"` | |
135+
| zulip.environment.SETTING_EMAIL_USE_SSL | string | `"False"` | |
136+
| zulip.environment.SETTING_EMAIL_USE_TLS | string | `"True"` | |
137+
| zulip.environment.SETTING_EXTERNAL_HOST | string | `"zulip.example.com"` | |
138+
| zulip.environment.SETTING_ZULIP_ADMINISTRATOR | string | `"[email protected]"` | |
139+
| zulip.environment.SSL_CERTIFICATE_GENERATION | string | `"self-signed"` | |
140+
| zulip.environment.TRUST_GATEWAY_IP | bool | `true` | |
141+
| zulip.environment.ZULIP_AUTH_BACKENDS | string | `"EmailAuthBackend"` | |
142+
| zulip.persistence.accessMode | string | `"ReadWriteOnce"` | |
143+
| zulip.persistence.enabled | bool | `true` | |
144+
| zulip.persistence.size | string | `"10Gi"` | |
145+
| zulip.persistence.storageClass | string | `nil` | |
146146

147147
## About this helm chart
148148

@@ -155,7 +155,7 @@ configuring Zulip through environment variables
155155
[here](https://github.com/zulip/docker-zulip/#configuration).
156156

157157
Variables can be either a plain scalar value (i.e., a string or
158-
integer), or a projected value from a secret or configmap. For
158+
integer), or a projected value from a secret or configmap. For
159159
example:
160160

161161
```yaml
@@ -182,9 +182,9 @@ image, because it contains the Postgresql plugins that are needed to run Zulip.
182182
183183
## Requirements
184184
185-
| Repository | Name | Version |
186-
|------------|------|---------|
187-
| oci://registry-1.docker.io/bitnamicharts | memcached | 8.1.5 |
188-
| oci://registry-1.docker.io/bitnamicharts | postgresql | 18.1.8 |
189-
| oci://registry-1.docker.io/bitnamicharts | rabbitmq | 16.0.14 |
190-
| oci://registry-1.docker.io/bitnamicharts | redis | 23.2.12 |
185+
| Repository | Name | Version |
186+
| ---------------------------------------- | ---------- | ------- |
187+
| oci://registry-1.docker.io/bitnamicharts | memcached | 8.1.5 |
188+
| oci://registry-1.docker.io/bitnamicharts | postgresql | 18.1.8 |
189+
| oci://registry-1.docker.io/bitnamicharts | rabbitmq | 16.0.14 |
190+
| oci://registry-1.docker.io/bitnamicharts | redis | 23.2.12 |

‎kubernetes/chart/zulip/README.md.gotmpl‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ configuring Zulip through environment variables
7777
[here](https://github.com/zulip/docker-zulip/#configuration).
7878

7979
Variables can be either a plain scalar value (i.e., a string or
80-
integer), or a projected value from a secret or configmap. For
80+
integer), or a projected value from a secret or configmap. For
8181
example:
8282

8383
```yaml

0 commit comments

Comments
 (0)