Repository navigation
Validate Helm descriptions before generation - #1260
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
🔵 Needs a closer look
The private SEP source remains inaccessible, leaving the release-specific description override unverified.
No open issues 🎉
What changed in this PR
Adds read-only Helm description validation to the release documentation generator, reporting missing descriptions across configured charts before writing pages.
Changes:
- Adds
--checkmode and aggregated validation. - Tests cross-chart reporting and read-only behavior, and runs generator tests in PR checks.
- Adds the metrics-port description override needed for SEP v0.23.0.
| File | Description |
|---|---|
| scripts/upstream-release/generate-helm-reference.test.mjs | Tests aggregated errors and read-only check mode. |
| scripts/upstream-release/generate-helm-reference.mjs | Adds validation and --check support. |
| .github/workflows/_static-checks.yaml | Runs generator tests in CI. |
| .github/upstream-projects.yaml | Supplies the guardrails metrics-port description. |
Review effort: Balanced
danbarr
enabled auto-merge (squash)
October 21, 2026 20:46
Nashon-Steffen
approved these changes
Oct 21, 2026
2 of 4 tasks
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
The SEP v0.23.0 reference export stopped at the first undocumented Helm value. Add a read-only
--checkmode that reports every missing description across the configured charts before generation writes pages, and run the generator tests in normal PR checks.Add the description override for
guardrails.adapter.metrics.portso the existing v0.23.0 tag can be regenerated. The source comment is included in the companion SEP change. Merge this PR before the SEP workflow change, which consumes--checkfrom docs-website main.Type of change
Related issues/PRs
Validation
node --test scripts/upstream-release/generate-helm-reference.test.mjs: 11 tests passed, including aggregation across charts and a CLI check that writes no pages and invokes no formatter.git diff --checkpassed.npm run buildpassed.Submitter checklist
Content and formatting
Reviewer checklist
Content