Skip to content

docs(helm): sync values table and badges with the chart - #8024

Merged
code-asher merged 1 commit into
coder:mainfrom
ZainnQureshii:docs/helm-values-table
Sep 29, 2026
Merged

code-asher merged 1 commit into
coder:mainfrom
ZainnQureshii:docs/helm-values-table

Conversation

@ZainnQureshii

Copy link
Copy Markdown
Contributor

No issue: minor docs fix.

docs/helm.md was moved here from the chart README in #4035/#4044 and has not been regenerated since, so the values table and badges no longer match ci/helm-chart.

Stale defaults (truth in ci/helm-chart/values.yaml):

  • image.tag: "4.8.0" -> "4.139.1" (values.yaml:9)
  • persistence.size: "1Gi" -> "10Gi"
  • service.port: 8443 -> 8080 (values.yaml:50)
  • serviceAccount.name: nil -> "" (values.yaml:32)

Badges: chart 1.0.0 -> 3.54.0, app 4.8.0 -> 4.139.1 (Chart.yaml:18,23).

Missing keys added: annotations, extraPorts, ingress.ingressClassName, lifecycle.enabled, livenessProbe.enabled, priorityClassName, readinessProbe.enabled, serviceAccount.annotations. I left out labels: it is in values.yaml, but no template reads .Values.labels, so documenting it would suggest a setting that does nothing.

Link: the "default values.yaml" tip linked values.yaml, which resolves to docs/values.yaml and is a 404 on https://coder.com/docs/code-server/latest/helm. It now links ../ci/helm-chart/values.yaml, the same relative style the other docs pages use.

Checked by comparing every leaf key and default in values.yaml against the table with a script, and prettier --check docs/helm.md passes.

Prepared with AI assistance (Claude Code) and reviewed with GitHub Copilot.

🤖 Generated with Claude Code

docs/helm.md was moved from the chart README in 2021 and never
regenerated. Four defaults were stale (image.tag, persistence.size,
service.port, serviceAccount.name), eight used keys in values.yaml were
missing, the version badges showed chart 1.0.0 / app 4.8.0, and the
values.yaml link resolved to docs/values.yaml, which does not exist.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@ZainnQureshii
ZainnQureshii requested a review from a team as a code owner September 29, 2026 11:20

@code-asher code-asher left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! I need to add a ci check for this or something so it stops getting out of date.

@code-asher
code-asher merged commit 2bb012c into coder:main Sep 29, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants