Skip to content

chore(website): validate generated example configs against vector validate#25933

Merged
pront merged 6 commits into
masterfrom
pront-validate-config-examples
Jul 23, 2026
Merged

chore(website): validate generated example configs against vector validate#25933
pront merged 6 commits into
masterfrom
pront-validate-config-examples

Conversation

@pront

@pront pront commented Jul 23, 2026

Copy link
Copy Markdown
Member

Summary

create-config-examples.js generates 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 through vector validate and 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-examples

How did you test this PR?

Ran yarn validate-config-examples on this branch: exits 0, 0 new failures, 101 known.

Change Type

  • Non-functional (chore, refactoring, docs)

Is this a breaking change?

  • No

Does this PR include user facing changes?

  • No. A maintainer will apply the no-changelog label to this PR.

@pront
pront requested review from a team as code owners July 23, 2026 14:51
@pront pront added no-changelog Changes in this PR do not need user-facing explanations in the release changelog domain: website labels Jul 23, 2026

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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".

Comment thread website/Makefile Outdated
Comment thread website/scripts/validate-config-examples.js
Comment thread website/scripts/validate-config-examples.js
@pront
pront enabled auto-merge July 23, 2026 15:15
@pront
pront added this pull request to the merge queue Jul 23, 2026
Merged via the queue into master with commit ad562e5 Jul 23, 2026
83 checks passed
@pront
pront deleted the pront-validate-config-examples branch July 23, 2026 15:49
@github-actions github-actions Bot locked and limited conversation to collaborators Jul 23, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

domain: website no-changelog Changes in this PR do not need user-facing explanations in the release changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants