Skip to content

fix(chart): keep the routes example out of the targets schema description - #126

Merged
onedr0p merged 1 commit into
mainfrom
fix/chart-schema-example-comments
Aug 18, 2026
Merged

onedr0p merged 1 commit into
mainfrom
fix/chart-schema-example-comments

Conversation

@onedr0p

@onedr0p onedr0p commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

Same fix as home-operations/gatus-sidecar#170: helm-schema attaches a commented example block to the next key's description in values.schema.json, which surfaces as hover docs in editors consuming the schema. One instance here: the alertmanager route example leaked into config.targets.

A blank line after the example block stops helm-schema from carrying it forward. Verified with a schema-wide scan (no leaked descriptions remain); chart README and config.schema.json are unchanged, helm unittest 20/20, helm lint clean.

…tion

helm-schema attaches trailing comment lines to the following key's
description, so the alertmanager route example leaked into
config.targets in values.schema.json. A blank line after the example
block stops that.

Signed-off-by: Devin Buhl <devin@buhl.casa>
@greptile-apps

greptile-apps Bot commented Aug 18, 2026

Copy link
Copy Markdown

Greptile Summary

This PR prevents an Alertmanager route example from leaking into the generated hover documentation for config.targets.

  • Adds a blank separator after the commented route example in values.yaml.
  • Removes the incorrectly attached example from the generated targets description in values.schema.json.

Confidence Score: 5/5

The PR appears safe to merge with no actionable issues identified.

The source annotation separator and generated schema description are consistent, and the change affects documentation metadata without altering chart runtime behavior.

Important Files Changed

Filename Overview
charts/chaski/values.yaml Adds the blank line required to keep the preceding commented example separate from the targets documentation during schema generation.
charts/chaski/values.schema.json Correctly removes the unrelated Alertmanager route example from the generated config.targets description.

Reviews (1): Last reviewed commit: "fix(chart): keep the routes example out ..." | Re-trigger Greptile

@onedr0p
onedr0p merged commit 910b384 into main Aug 18, 2026
13 checks passed
@onedr0p
onedr0p deleted the fix/chart-schema-example-comments branch August 18, 2026 18:10
@sticky-gecko sticky-gecko Bot mentioned this pull request Aug 18, 2026
gabrielcosi pushed a commit to gabrielcosi/home-ops that referenced this pull request Aug 21, 2026
…(0.4.1 ➔ 0.5.0) (#475)

This PR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [ghcr.io/home-operations/charts/chaski](https://github.com/home-operations/chaski) | minor | `0.4.1` → `0.5.0` |

---

### Release Notes

<details>
<summary>home-operations/chaski (ghcr.io/home-operations/charts/chaski)</summary>

### [`v0.5.0`](https://github.com/home-operations/chaski/blob/HEAD/CHANGELOG.md#050-2026-08-21)

[Compare Source](home-operations/chaski@0.4.1...0.5.0)

##### ⚠ BREAKING CHANGES

- **go:** Update module github.com/emersion/go-smtp (v0.24.0 → v0.25.0) ([#&#8203;114](home-operations/chaski#114))

##### Features

- **go:** Update module github.com/emersion/go-smtp (v0.24.0 → v0.25.0) ([#&#8203;114](home-operations/chaski#114)) ([674c1ad](home-operations/chaski@674c1ad))
- **go:** update module github.com/go-sprout/sprout (v1.0.3 → v1.1.0) ([#&#8203;120](home-operations/chaski#120)) ([bf282bb](home-operations/chaski@bf282bb))
- **go:** update module github.com/google/cel-go (v0.31.0 → v0.32.0) ([#&#8203;127](home-operations/chaski#127)) ([fe94c7a](home-operations/chaski@fe94c7a))

##### Bug Fixes

- **chart:** keep the routes example out of the targets schema description ([#&#8203;126](home-operations/chaski#126)) ([910b384](home-operations/chaski@910b384))
- **go:** update module github.com/go-sprout/sprout (v1.1.0 → v1.1.1) ([#&#8203;128](home-operations/chaski#128)) ([3289a2d](home-operations/chaski@3289a2d))
- **go:** update module github.com/unraid/apprise-go (v0.3.0 → v0.3.1) ([#&#8203;113](home-operations/chaski#113)) ([801791f](home-operations/chaski@801791f))
- **go:** update module github.com/unraid/apprise-go (v0.3.1 → v0.3.2) ([#&#8203;119](home-operations/chaski#119)) ([a5a498b](home-operations/chaski@a5a498b))
- **go:** update to go 1.27.0 ([#&#8203;129](home-operations/chaski#129)) ([bcc3948](home-operations/chaski@bcc3948))

##### Miscellaneous Chores

- **github-action:** update action jdx/mise-action (v4.2.4 → v4.2.5) ([#&#8203;121](home-operations/chaski#121)) ([a738b88](home-operations/chaski@a738b88))
- **go:** pin go directive to 1.26.0 ([#&#8203;122](home-operations/chaski#122)) ([000f1fd](home-operations/chaski@000f1fd))
- **mise:** update tool go (1.26.5 → 1.26.6) ([#&#8203;125](home-operations/chaski#125)) ([5471e54](home-operations/chaski@5471e54))
- **mise:** update tool go:golang.org/x/vuln/cmd/govulncheck (1.6.0 → v1.7.0) ([#&#8203;118](home-operations/chaski#118)) ([a82b986](home-operations/chaski@a82b986))
- **mise:** update tool helm (4.2.3 → 4.2.4) ([#&#8203;124](home-operations/chaski#124)) ([dc097ff](home-operations/chaski@dc097ff))
- **mise:** Update tool oxfmt (0.62.0 → 0.63.0) ([#&#8203;115](home-operations/chaski#115)) ([6b34179](home-operations/chaski@6b34179))

</details>

---

### Configuration

📅 **Schedule**: (in timezone Europe/Berlin)

- Branch creation
  - At any time (no schedule defined)
- Automerge
  - At any time (no schedule defined)

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Mend Renovate CLI](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0NC4zMC4zIiwidXBkYXRlZEluVmVyIjoiNDQuMzAuMyIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsicmVub3ZhdGUvY29udGFpbmVyIiwidHlwZS9taW5vciJdfQ==-->

Reviewed-on: https://git.xcd.dev/gabrielcosi/home-ops/pulls/475
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.

1 participant