docs(talm): document chart drift detection and strict mode#577
docs(talm): document chart drift detection and strict mode#577Aleksei Sviridkin (lexfrei) wants to merge 1 commit into
Conversation
Cover the two drift signals a talm binary upgrade can surface (vendored library content drift, preset baseline drift via .talm-preset.lock), the exact re-sync semantics of init --update, and the strictCharts / --strict-charts escalation including the unverifiable-baseline behavior. Assisted-By: Claude <noreply@anthropic.com> Signed-off-by: Aleksei Sviridkin <f@lex.la>
✅ Deploy Preview for cozystack ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThis PR updates the Kubernetes-on-Talos installation guide to document two talm features: the ChangesTalm Installation and Update Documentation
🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the Talm documentation to include details about the .talm-preset.lock file and a new section on Chart Drift Detection (Talm v0.32+), which covers library drift, preset drift, and strict mode. The review comments suggest minor grammatical and readability enhancements to the new text, specifically adding the relative pronoun 'that' and inserting commas after introductory adverbial phrases.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
| talm init --update --preset cozystack --force # non-interactive: auto-accept all diffs | ||
| ``` | ||
|
|
||
| `--update` re-syncs the vendored `charts/talm/` exactly — files the new library no longer ships (or strays like `.DS_Store`) are pruned — and advances the preset baseline in `.talm-preset.lock`. |
There was a problem hiding this comment.
Adding the relative pronoun 'that' improves the grammatical flow and readability of this sentence.
| `--update` re-syncs the vendored `charts/talm/` exactly — files the new library no longer ships (or strays like `.DS_Store`) are pruned — and advances the preset baseline in `.talm-preset.lock`. | |
| `--update` re-syncs the vendored `charts/talm/` exactly — files that the new library no longer ships (or strays like `.DS_Store`) are pruned — and advances the preset baseline in `.talm-preset.lock`. |
| - **Library drift**: the vendored `charts/talm/` differs by content from the copy built into the binary. A pure version stamp difference stays silent; a real difference is reported with a sample of the differing paths (`modified:` / `extra:` / `missing:`). | ||
| - **Preset drift**: the binary ships a newer preset than the baseline pinned in `.talm-preset.lock` at init time. Your `templates/` edits are never reported as drift — the comparison is binary-vs-baseline, not binary-vs-project. | ||
|
|
||
| Both warnings point at the remediation above. To escalate the warning into a hard error (exit 1) — for example, in CI — set `strictCharts: true` in `Chart.yaml` so the whole team inherits it, or pass `--strict-charts` for a single run. Under strict mode a baseline that cannot be verified (a corrupted or deleted `.talm-preset.lock`, an unreadable `charts/talm/`) also blocks, so deleting the baseline is not a bypass; without strict mode such failures degrade to a warning, and projects created before baseline pinning stay silent. |
There was a problem hiding this comment.
Adding commas after introductory adverbial phrases ('Under strict mode' and 'without strict mode') improves readability and sentence structure.
| Both warnings point at the remediation above. To escalate the warning into a hard error (exit 1) — for example, in CI — set `strictCharts: true` in `Chart.yaml` so the whole team inherits it, or pass `--strict-charts` for a single run. Under strict mode a baseline that cannot be verified (a corrupted or deleted `.talm-preset.lock`, an unreadable `charts/talm/`) also blocks, so deleting the baseline is not a bypass; without strict mode such failures degrade to a warning, and projects created before baseline pinning stay silent. | |
| Both warnings point at the remediation above. To escalate the warning into a hard error (exit 1) — for example, in CI — set `strictCharts: true` in `Chart.yaml` so the whole team inherits it, or pass `--strict-charts` for a single run. Under strict mode, a baseline that cannot be verified (a corrupted or deleted `.talm-preset.lock`, an unreadable `charts/talm/`) also blocks, so deleting the baseline is not a bypass; without strict mode, such failures degrade to a warning, and projects created before baseline pinning stay silent. |
Aleksei Sviridkin (lexfrei)
requested review from
Andrei Kvapil (kvaps) and
Timofei Larkin (lllamnyp)
as code owners
1 participant
Documents the chart drift detection that lands in talm with cozystack/talm#216: the library-content and preset-baseline drift warnings, the
.talm-preset.lockfile (including the advice to commit it), the exact re-sync semantics oftalm init --update, and thestrictCharts: true/--strict-chartsescalation with its unverifiable-baseline behavior.Targets
docs/next/only — the feature ships in the next talm release. Companion to cozystack/talm#216.Summary by CodeRabbit