Skip to content

Upgrade helm-docs action & improve diff output #8575

@omerap12

Description

@omerap12

We currently generate Helm docs (for both CA and VPA) using the following GitHub Action:
https://github.com/kubernetes/autoscaler/blob/master/.github/workflows/pr.yaml#L62

The workflow checks whether the generated README.md differs from what’s committed, and fails the PR if there’s a mismatch:
https://github.com/kubernetes/autoscaler/blob/master/.github/workflows/pr.yaml#L63-L64

When running the same Docker image (jnorwood/helm-docs:v1.3.0) on an ARM-based machine, we hit a platform mismatch error:

ubuntu:~/autoscaler/charts(vpa-chart)$ docker run --rm --volume "$(pwd):/helm-docs" -u $(id -u) jnorwood/helm-docs:v1.3.0
WARNING: The requested image's platform (linux/amd64) does not match the detected host platform (linux/arm64/v8) and no specific platform was requested
exec /usr/bin/helm-docs: exec format error

Using the latest image resolves the issue locally:

ubuntu:~/autoscaler/charts(vpa-chart)$ docker run --rm --volume "$(pwd):/helm-docs" -u $(id -u) jnorwood/helm-docs:latest
time="2025-09-26T09:50:24Z" level=info msg="Found Chart directories [cluster-autoscaler, vertical-pod-autoscaler]"
time="2025-09-26T09:50:24Z" level=info msg="Generating README Documentation for chart vertical-pod-autoscaler"
time="2025-09-26T09:50:24Z" level=info msg="Generating README Documentation for chart cluster-autoscaler"

However, CI then fails because it uses an older version, and the generated README differs.

Required Changes:

  1. Update the GitHub Action to use the latest jnorwood/helm-docs version (please don't use latest but a fixed version - 1.14.2. for more info: https://github.com/norwoodj/helm-docs
  2. Regenerate the README.md files for both CA and VPA to match the updated version output.
  3. Improve developer experience: currently, the diff check runs with --quiet. we should provide more detailed output so contributors can understand why the pipeline failed and what needs to be updated.

Metadata

Metadata

Assignees

Labels

area/helm-chartsgood first issueDenotes an issue ready for a new contributor, according to the "help wanted" guidelines.help wantedDenotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.triage/acceptedIndicates an issue or PR is ready to be actively worked on.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions