Skip to content

Commit 7887417

Browse files
banjohpaigecalvert
andauthored
feat: add helm-schema-violation linter rule to docs (#4036)
* feat: add helm-schema-violation linter rule to docs Signed-off-by: Evans Mungai <evans@replicated.com> * Change Signed-off-by: Evans Mungai <evans@replicated.com> * Change Signed-off-by: Evans Mungai <evans@replicated.com> * Update linter.mdx --------- Signed-off-by: Evans Mungai <evans@replicated.com> Co-authored-by: Paige Calvert <paige@replicated.com>
1 parent 3ae48a7 commit 7887417

1 file changed

Lines changed: 23 additions & 0 deletions

File tree

docs/reference/linter.mdx

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -600,6 +600,29 @@ For more information, see [LintConfig](custom-resource-lintconfig).
600600
</tr>
601601
</table>
602602

603+
### helm-schema-violation
604+
605+
<table>
606+
<tr>
607+
<th>Description</th>
608+
<td>
609+
<p>Runs <code>helm lint</code> against each Helm chart archive in the release that is referenced by a HelmChart custom resource. Uses the chart's default values merged with <code>spec.builder</code> values from the HelmChart custom resource. Surfaces any violations reported by Helm, including JSON schema validation errors from the chart's <code>values.schema.json</code>.</p>
610+
<p>Each top-level violation is reported as a separate finding so that individual schema errors are easier to read and address.</p>
611+
<p>For more information about <code>spec.builder</code>, see <a href="/reference/custom-resource-helmchart-v2#builder">builder</a> in <em>HelmChart v2</em>.</p>
612+
</td>
613+
</tr>
614+
<tr>
615+
<th>Level</th>
616+
<td>Error</td>
617+
</tr>
618+
<tr>
619+
<th>Applies To</th>
620+
<td>
621+
Helm v3 and later chart archives (<code>*.tar.gz</code>) that have a matching HelmChart custom resource. HelmChart custom resources with <code>helmVersion: v2</code> are skipped.
622+
</td>
623+
</tr>
624+
</table>
625+
603626
### invalid-helm-release-name
604627

605628
<table>

0 commit comments

Comments
 (0)