Skip to content

fix(helm): prettify generated documentation #464

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
neilime merged 1 commit into from
Jul 11, 2025
Merged

fix(helm): prettify generated documentation #464

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion .github/workflows/__test-action-helm-test-chart.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@ jobs:
with:
check-diff-only: false
helm-set: |
image.tag=0.1.0
image.tag=${{ fromJson(needs.build-test-images.outputs.built-images).application-test.tags[0] }}
image.digest=${{ fromJson(needs.build-test-images.outputs.built-images).application-test.digest }}
helm-repositories: |
bitnami https://charts.bitnami.com/bitnami
oci-registry: ghcr.io
Expand Down
17 changes: 16 additions & 1 deletion actions/helm/generate-docs/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,28 @@ runs:
- shell: bash
id: prepare-variables
run: |
if [ ! -d "${{ inputs.working-directory }}" ]; then
echo "The working directory '${{ inputs.working-directory }}' does not exist."
exit 1
fi
working_directory=$(realpath "${{ inputs.working-directory }}")

echo "working-directory=${{ inputs.working-directory }}" >> "$GITHUB_OUTPUT"
echo "working-directory-name=$(basename "${{ inputs.working-directory }}")" >> "$GITHUB_OUTPUT"

- uses: hoverkraft-tech/ci-github-common/actions/checkout@6857ef6d10f704e0998aa4955282f27d1b9be778 # 0.23.1

- uses: losisin/helm-docs-github-action@178c1a8927bcd668d487395beda342ba270895b3 # v1.6.1
with:
chart-search-root: ${{ inputs.working-directory }}
chart-search-root: ${{ steps.prepare-variables.outputs.working-directory }}

- name: Prettify code
uses: creyD/prettier_action@8c18391fdc98ed0d884c6345f03975edac71b8f0 # v4.6
with:
prettier_options: --write ${{ steps.prepare-variables.outputs.working-directory }}/**/*.md
only_changed: true
no_commit: true
working_directory: ${{ steps.prepare-variables.outputs.working-directory }}

- uses: actions/create-github-app-token@df432ceedc7162793a195dd1713ff69aefc7379e # v2.0.6
if: inputs.github-app-id
Expand Down
114 changes: 57 additions & 57 deletions tests/charts/application/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,63 +6,63 @@ A Helm chart for Kubernetes

## Requirements

| Repository | Name | Version |
|------------|------|---------|
| https://charts.bitnami.com/bitnami | mysql | 12.2.1 |
| Repository | Name | Version |
| ------------------------------------ | ----- | ------- |
| <https://charts.bitnami.com/bitnami> | MySQL | 12.2.1 |

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| affinity | object | `{}` | |
| application.dbConnection | string | `"mysql"` | |
| application.dbDatabase | string | `"test"` | |
| application.dbHost | string | `"mysql"` | |
| application.dbPassword | string | `"test"` | |
| application.dbPort | int | `3306` | |
| application.dbUsername | string | `"test"` | |
| autoscaling.enabled | bool | `false` | |
| autoscaling.maxReplicas | int | `100` | |
| autoscaling.minReplicas | int | `1` | |
| autoscaling.targetCPUUtilizationPercentage | int | `80` | |
| fullnameOverride | string | `""` | |
| image.digest | string | `"sha256:da3b65f32ea75f8041079d220b72da4f605738996256a7dc32715424cc117271"` | |
| image.pullPolicy | string | `"Always"` | |
| image.registry | string | `"ghcr.io"` | |
| image.repository | string | `"hoverkraft-tech/ci-github-container/application-test"` | |
| image.tag | string | `""` | |
| imagePullSecrets | list | `[]` | |
| ingress.annotations | object | `{}` | |
| ingress.className | string | `""` | |
| ingress.enabled | bool | `false` | |
| ingress.hosts[0].host | string | `"chart-example.local"` | |
| ingress.hosts[0].paths[0].path | string | `"/"` | |
| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | |
| ingress.tls | list | `[]` | |
| mysql.auth.database | string | `"test"` | |
| mysql.auth.password | string | `"test"` | |
| mysql.auth.rootPassword | string | `"root"` | |
| mysql.auth.username | string | `"test"` | |
| mysql.enabled | bool | `false` | |
| mysql.fullnameOverride | string | `"mysql"` | |
| nameOverride | string | `""` | |
| nodeSelector | object | `{}` | |
| podAnnotations | object | `{}` | |
| podSecurityContext | object | `{}` | |
| replicaCount | int | `1` | |
| resources.limits.cpu | string | `"100m"` | |
| resources.limits.memory | string | `"128Mi"` | |
| resources.requests.cpu | string | `"100m"` | |
| resources.requests.memory | string | `"128Mi"` | |
| securityContext.allowPrivilegeEscalation | bool | `false` | |
| securityContext.capabilities.drop[0] | string | `"ALL"` | |
| securityContext.readOnlyRootFilesystem | bool | `true` | |
| securityContext.runAsNonRoot | bool | `true` | |
| securityContext.runAsUser | int | `10001` | |
| securityContext.seccompProfile.type | string | `"RuntimeDefault"` | |
| service.port | int | `8080` | |
| service.type | string | `"ClusterIP"` | |
| serviceAccount.annotations | object | `{}` | |
| serviceAccount.create | bool | `true` | |
| serviceAccount.name | string | `""` | |
| tolerations | list | `[]` | |
| Key | Type | Default | Description |
| ------------------------------------------ | ------ | --------------------------------------------------------------------------- | ----------- |
| affinity | object | `{}` | |
| application.dbConnection | string | `"mysql"` | |
| application.dbDatabase | string | `"test"` | |
| application.dbHost | string | `"mysql"` | |
| application.dbPassword | string | `"test"` | |
| application.dbPort | int | `3306` | |
| application.dbUsername | string | `"test"` | |
| autoscaling.enabled | bool | `false` | |
| autoscaling.maxReplicas | int | `100` | |
| autoscaling.minReplicas | int | `1` | |
| autoscaling.targetCPUUtilizationPercentage | int | `80` | |
| fullnameOverride | string | `""` | |
| image.digest | string | `"sha256:da3b65f32ea75f8041079d220b72da4f605738996256a7dc32715424cc117271"` | |
| image.pullPolicy | string | `"Always"` | |
| image.registry | string | `"ghcr.io"` | |
| image.repository | string | `"hoverkraft-tech/ci-github-container/application-test"` | |
| image.tag | string | `""` | |
| imagePullSecrets | list | `[]` | |
| ingress.annotations | object | `{}` | |
| ingress.className | string | `""` | |
| ingress.enabled | bool | `false` | |
| ingress.hosts[0].host | string | `"chart-example.local"` | |
| ingress.hosts[0].paths[0].path | string | `"/"` | |
| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | |
| ingress.tls | list | `[]` | |
| mysql.auth.database | string | `"test"` | |
| mysql.auth.password | string | `"test"` | |
| mysql.auth.rootPassword | string | `"root"` | |
| mysql.auth.username | string | `"test"` | |
| mysql.enabled | bool | `false` | |
| mysql.fullnameOverride | string | `"mysql"` | |
| nameOverride | string | `""` | |
| nodeSelector | object | `{}` | |
| podAnnotations | object | `{}` | |
| podSecurityContext | object | `{}` | |
| replicaCount | int | `1` | |
| resources.limits.cpu | string | `"100m"` | |
| resources.limits.memory | string | `"128Mi"` | |
| resources.requests.cpu | string | `"100m"` | |
| resources.requests.memory | string | `"128Mi"` | |
| securityContext.allowPrivilegeEscalation | bool | `false` | |
| securityContext.capabilities.drop[0] | string | `"ALL"` | |
| securityContext.readOnlyRootFilesystem | bool | `true` | |
| securityContext.runAsNonRoot | bool | `true` | |
| securityContext.runAsUser | int | `10001` | |
| securityContext.seccompProfile.type | string | `"RuntimeDefault"` | |
| service.port | int | `8080` | |
| service.type | string | `"ClusterIP"` | |
| serviceAccount.annotations | object | `{}` | |
| serviceAccount.create | bool | `true` | |
| serviceAccount.name | string | `""` | |
| tolerations | list | `[]` | |
2 changes: 1 addition & 1 deletion tests/charts/application/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ image:
registry: "ghcr.io"
repository: "hoverkraft-tech/ci-github-container/application-test"
tag: ""
digest: "sha256:da3b65f32ea75f8041079d220b72da4f605738996256a7dc32715424cc117271"
digest: "sha256:0000000000000000000000000000000000000000000000000000000000000000"

imagePullSecrets: []

Expand Down
26 changes: 13 additions & 13 deletions tests/charts/umbrella-application/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,19 @@ An umbrella Helm chart for Kubernetes

## Requirements

| Repository | Name | Version |
|------------|------|---------|
| file://./charts/app | app | 0.0.0 |
| https://charts.bitnami.com/bitnami | database(mysql) | 12.2.1 |
| Repository | Name | Version |
| ------------------------------------ | --------------- | ------- |
| file://./charts/app | app | 0.0.0 |
| <https://charts.bitnami.com/bitnami> | database(MySQL) | 12.2.1 |

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| app.enabled | bool | `true` | |
| database.auth.database | string | `"test-umbrella-application"` | |
| database.auth.username | string | `"test-umbrella-application"` | |
| database.enabled | bool | `true` | |
| database.fullnameOverride | string | `"database"` | |
| global.fullnameOverride | string | `""` | |
| global.nameOverride | string | `""` | |
| Key | Type | Default | Description |
| ------------------------- | ------ | ----------------------------- | ----------- |
| app.enabled | bool | `true` | |
| database.auth.database | string | `"test-umbrella-application"` | |
| database.auth.username | string | `"test-umbrella-application"` | |
| database.enabled | bool | `true` | |
| database.fullnameOverride | string | `"database"` | |
| global.fullnameOverride | string | `""` | |
| global.nameOverride | string | `""` | |
Loading
Loading