feat: add helm-schema-violation linter rule to docs#4036
Conversation
Signed-off-by: Evans Mungai <evans@replicated.com>
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for replicated-docs-upgrade ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
replicated-ci
added
type::docs
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| </tr> | ||
| </table> | ||
|
|
||
| ### helm-schema-violation |
There was a problem hiding this comment.
[Replicated.Headings] 'helm-schema-violation' should use sentence case.
| <tr> | ||
| <th>Description</th> | ||
| <td> | ||
| <p>Runs <code>helm lint</code> against each Helm chart archive in the release that is referenced by a HelmChart custom resource, using 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> |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Passive] In general, use active voice instead of passive voice ('is referenced').
| <th>Description</th> | ||
| <td> | ||
| <p>Runs <code>helm lint</code> against each Helm chart archive in the release that is referenced by a HelmChart custom resource, using 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> | ||
| <p>Each top-level violation is reported as a separate finding so that individual schema errors are easier to read and address.</p> |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Passive] In general, use active voice instead of passive voice ('is reported').
| <tr> | ||
| <th>Applies To</th> | ||
| <td> | ||
| Helm v3 and above chart archives (<code>*.tar.gz</code>) that have a matching HelmChart custom resource manifest file with <code>kind: HelmChart</code> and <code>apiVersion: kots.io/v1beta1</code>. HelmChart custom resources with <code>helmVersion: v2</code> are skipped. |
There was a problem hiding this comment.
[Replicated.PositionalLanguage] Avoid spacial and directional language like 'above'. Instead, use 'on this page', 'the following', or link to the section.
| <tr> | ||
| <th>Applies To</th> | ||
| <td> | ||
| Helm v3 and above chart archives (<code>*.tar.gz</code>) that have a matching HelmChart custom resource manifest file with <code>kind: HelmChart</code> and <code>apiVersion: kots.io/v1beta1</code>. HelmChart custom resources with <code>helmVersion: v2</code> are skipped. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Passive] In general, use active voice instead of passive voice ('are skipped').
| <tr> | ||
| <th>Description</th> | ||
| <td> | ||
| <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> |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Passive] In general, use active voice instead of passive voice ('is referenced').
| <tr> | ||
| <th>Applies To</th> | ||
| <td> | ||
| 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. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Passive] In general, use active voice instead of passive voice ('are skipped').
banjoh
deleted the
evansmungai/sc-136401/replicated-registry-injects-global-replicated
branch
4 participants
https://deploy-preview-4036--replicated-docs.netlify.app/reference/linter#helm-schema-violation