chore(website): validate generated example configs against vector validate#25933
Merged
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 53ac5a150b
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
pront
enabled auto-merge
July 23, 2026 15:15
thomasqueirozb
approved these changes
Jul 23, 2026
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Summary
create-config-examples.jsgenerates the example configs shown on the vector.dev reference pages. Until now there was no automated check that those configs are actually valid. This means that bugs in the generation logic (missing required fields, wrong types) would silently produce broken examples that users copy-paste.This PR adds
validate-config-examples.js, which runs every generated example throughvector validateand fails if any new invalid configs appear. An allowlist captures the 101 pre-existing failures on master so the check is a clean regression gate from day one.Follow-up PRs will remove entries as those failures are fixed and eventually this check can become a CI gate.
Usage:
cd website make validate-config-examplesHow did you test this PR?
Ran
yarn validate-config-exampleson this branch: exits 0, 0 new failures, 101 known.Change Type
Is this a breaking change?
Does this PR include user facing changes?
no-changeloglabel to this PR.