Skip to content

Commit b91bf11

Browse files
committed
fix(helm/generate-docs): lint generated files
Signed-off-by: Emilien Escalle <[email protected]>
1 parent 9bcca87 commit b91bf11

File tree

2 files changed

+67
-66
lines changed

2 files changed

+67
-66
lines changed

actions/helm/generate-docs/action.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ runs:
151151
env:
152152
CACHE_PATH: ${{ runner.temp }}/.cache-textlint
153153
CONFIG_PATH: ${{ steps.prepare-variables.outputs.textlint-config-path }}
154-
run: npx textlint --cache-location $CACHE_PATH --fix --config $CONFIG_PATH $(pwd)/**/*.md
154+
run: npx textlint --cache-location "$CACHE_PATH" --fix --config "$CONFIG_PATH" "$(pwd)/**/*.md"
155155

156156
- name: Lint Fix markdown files
157157
uses: DavidAnson/markdownlint-cli2-action@992badcdf24e3b8eb7e87ff9287fe931bcb00c6e # v20.0.0
@@ -175,10 +175,10 @@ runs:
175175
VALUES_FILE: ${{ steps.prepare-variables.outputs.values-file || '' }}
176176
run: |
177177
# First run
178-
npx prettier --cache-location $CACHE_PATH --write $(pwd)/**/*.md $VALUES_FILE
178+
npx prettier --cache-location "$CACHE_PATH" --write "$(pwd)/**/*.md" "$VALUES_FILE"
179179
180180
# Second run to ensure idempotency
181-
npx prettier --cache-location $CACHE_PATH --write $(pwd)/**/*.md $VALUES_FILE
181+
npx prettier --cache-location "$CACHE_PATH" --write "$(pwd)/**/*.md" "$VALUES_FILE"
182182
183183
- uses: actions/create-github-app-token@67018539274d69449ef7c02e8e71183d1719ab42 # v2.1.4
184184
if: inputs.github-app-id

tests/charts/umbrella-application/charts/app/README.md

Lines changed: 64 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -6,68 +6,69 @@ An umbrella Helm chart for Kubernetes (app component)
66

77
## Values
88

9-
| Key | Type | Default | Description |
10-
|-----|------|---------|-------------|
11-
| affinity | object | `{}` | |
12-
| app.dbConnection | string | `"mysql"` | |
13-
| app.dbDatabase | string | `"test"` | |
14-
| app.dbHost | string | `"mysql"` | |
15-
| app.dbPassword | string | `"test"` | |
16-
| app.dbPort | int | `3306` | |
17-
| app.dbUsername | string | `"test"` | |
18-
| autoscaling.enabled | bool | `false` | |
19-
| autoscaling.maxReplicas | int | `100` | |
20-
| autoscaling.minReplicas | int | `1` | |
21-
| autoscaling.targetCPUUtilizationPercentage | int | `80` | |
22-
| autoscaling.targetMemoryUtilizationPercentage | int | `80` | |
23-
| fullnameOverride | string | `""` | |
24-
| image.digest | string | `"sha256:da3b65f32ea75f8041079d220b72da4f605738996256a7dc32715424cc117271"` | |
25-
| image.pullPolicy | string | `"Always"` | |
26-
| image.registry | string | `"ghcr.io"` | |
27-
| image.repository | string | `"hoverkraft-tech/ci-github-container/application-test"` | |
28-
| image.tag | string | `""` | |
29-
| imagePullSecrets | list | `[]` | |
30-
| ingress.annotations | object | `{}` | |
31-
| ingress.className | string | `""` | |
32-
| ingress.enabled | bool | `false` | |
33-
| ingress.hosts[0].host | string | `"chart-example.local"` | |
34-
| ingress.hosts[0].paths[0].path | string | `"/"` | |
35-
| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | |
36-
| ingress.tls | list | `[]` | |
37-
| mysql.auth.database | string | `"test"` | |
38-
| mysql.auth.password | string | `"test"` | |
39-
| mysql.auth.rootPassword | string | `"root"` | |
40-
| mysql.auth.username | string | `"test"` | |
41-
| mysql.enabled | bool | `false` | |
42-
| mysql.fullnameOverride | string | `"mysql"` | |
43-
| mysql.image.repository | string | `"bitnamilegacy/mysql"` | |
44-
| mysql.metrics.image.repository | string | `"bitnamilegacy/mysqld-exporter"` | |
45-
| mysql.volumePermissions.image.repository | string | `"bitnamilegacy/os-shell"` | |
46-
| nameOverride | string | `""` | |
47-
| namespace | string | `"app-system"` | |
48-
| networkPolicy.egress | list | `[]` | |
49-
| networkPolicy.enabled | bool | `true` | |
50-
| networkPolicy.ingress | list | `[]` | |
51-
| nodeSelector | object | `{}` | |
52-
| podAnnotations | object | `{}` | |
53-
| podSecurityContext | object | `{}` | |
54-
| replicaCount | int | `1` | |
55-
| resources.limits.cpu | string | `"100m"` | |
56-
| resources.limits.memory | string | `"128Mi"` | |
57-
| resources.requests.cpu | string | `"100m"` | |
58-
| resources.requests.memory | string | `"128Mi"` | |
59-
| securityContext.allowPrivilegeEscalation | bool | `false` | |
60-
| securityContext.capabilities.drop[0] | string | `"ALL"` | |
61-
| securityContext.readOnlyRootFilesystem | bool | `true` | |
62-
| securityContext.runAsNonRoot | bool | `true` | |
63-
| securityContext.runAsUser | int | `10001` | |
64-
| securityContext.seccompProfile.type | string | `"RuntimeDefault"` | |
65-
| service.port | int | `8080` | |
66-
| service.type | string | `"ClusterIP"` | |
67-
| serviceAccount.annotations | object | `{}` | |
68-
| serviceAccount.create | bool | `true` | |
69-
| serviceAccount.name | string | `""` | |
70-
| tolerations | list | `[]` | |
9+
| Key | Type | Default | Description |
10+
| --------------------------------------------- | ------ | --------------------------------------------------------------------------- | ----------- |
11+
| affinity | object | `{}` | |
12+
| app.dbConnection | string | `"mysql"` | |
13+
| app.dbDatabase | string | `"test"` | |
14+
| app.dbHost | string | `"mysql"` | |
15+
| app.dbPassword | string | `"test"` | |
16+
| app.dbPort | int | `3306` | |
17+
| app.dbUsername | string | `"test"` | |
18+
| autoscaling.enabled | bool | `false` | |
19+
| autoscaling.maxReplicas | int | `100` | |
20+
| autoscaling.minReplicas | int | `1` | |
21+
| autoscaling.targetCPUUtilizationPercentage | int | `80` | |
22+
| autoscaling.targetMemoryUtilizationPercentage | int | `80` | |
23+
| fullnameOverride | string | `""` | |
24+
| image.digest | string | `"sha256:da3b65f32ea75f8041079d220b72da4f605738996256a7dc32715424cc117271"` | |
25+
| image.pullPolicy | string | `"Always"` | |
26+
| image.registry | string | `"ghcr.io"` | |
27+
| image.repository | string | `"hoverkraft-tech/ci-github-container/application-test"` | |
28+
| image.tag | string | `""` | |
29+
| imagePullSecrets | list | `[]` | |
30+
| ingress.annotations | object | `{}` | |
31+
| ingress.className | string | `""` | |
32+
| ingress.enabled | bool | `false` | |
33+
| ingress.hosts[0].host | string | `"chart-example.local"` | |
34+
| ingress.hosts[0].paths[0].path | string | `"/"` | |
35+
| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | |
36+
| ingress.tls | list | `[]` | |
37+
| mysql.auth.database | string | `"test"` | |
38+
| mysql.auth.password | string | `"test"` | |
39+
| mysql.auth.rootPassword | string | `"root"` | |
40+
| mysql.auth.username | string | `"test"` | |
41+
| mysql.enabled | bool | `false` | |
42+
| mysql.fullnameOverride | string | `"mysql"` | |
43+
| mysql.image.repository | string | `"bitnamilegacy/mysql"` | |
44+
| mysql.metrics.image.repository | string | `"bitnamilegacy/mysqld-exporter"` | |
45+
| mysql.volumePermissions.image.repository | string | `"bitnamilegacy/os-shell"` | |
46+
| nameOverride | string | `""` | |
47+
| namespace | string | `"app-system"` | |
48+
| networkPolicy.egress | list | `[]` | |
49+
| networkPolicy.enabled | bool | `true` | |
50+
| networkPolicy.ingress | list | `[]` | |
51+
| nodeSelector | object | `{}` | |
52+
| podAnnotations | object | `{}` | |
53+
| podSecurityContext | object | `{}` | |
54+
| replicaCount | int | `1` | |
55+
| resources.limits.cpu | string | `"100m"` | |
56+
| resources.limits.memory | string | `"128Mi"` | |
57+
| resources.requests.cpu | string | `"100m"` | |
58+
| resources.requests.memory | string | `"128Mi"` | |
59+
| securityContext.allowPrivilegeEscalation | bool | `false` | |
60+
| securityContext.capabilities.drop[0] | string | `"ALL"` | |
61+
| securityContext.readOnlyRootFilesystem | bool | `true` | |
62+
| securityContext.runAsNonRoot | bool | `true` | |
63+
| securityContext.runAsUser | int | `10001` | |
64+
| securityContext.seccompProfile.type | string | `"RuntimeDefault"` | |
65+
| service.port | int | `8080` | |
66+
| service.type | string | `"ClusterIP"` | |
67+
| serviceAccount.annotations | object | `{}` | |
68+
| serviceAccount.create | bool | `true` | |
69+
| serviceAccount.name | string | `""` | |
70+
| tolerations | list | `[]` | |
71+
72+
---
7173

72-
----------------------------------------------
7374
Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)

0 commit comments

Comments
 (0)