Skip to content

docs(component docs): commit generated config examples - #26002

Merged
pront merged 1 commit into
masterfrom
pront/commit-config-examples
Aug 3, 2026
Merged

docs(component docs): commit generated config examples#26002
pront merged 1 commit into
masterfrom
pront/commit-config-examples

Conversation

@pront

@pront pront commented Aug 3, 2026

Copy link
Copy Markdown
Member

Summary

Component examples are currently generated into ignored website/data/docs.json. That makes config changes unavailable for review and prevents CI from detecting drift or validating the generated configurations. These examples are the first section readers encounter in component documentation, so keeping them valid is essential to making the docs trustworthy. This PR commits the YAML artifacts and makes them an independently validated CI input.

  • Generate 254 minimal and advanced YAML examples under website/generated/example-configs/.
  • Keep Hugo's multi-format examples populated from the same generation pass.
  • Detect stale generated examples and validate the committed YAML in the generated-docs CI job.
  • Run the job when its generator, validator, CUE, Makefile, or generated-artifact inputs change.
  • Reuse the target/debug/vector binary already built for schema generation. The job's shared Cargo/target cache avoids a second full Vector build for validation.

Vector configuration

Not applicable; this changes generated component example artifacts and their validation.

How did you test this PR?

  • make generate-example-configs
  • make -C website validate-config-examples — 250 examples validated; 4 trace-only examples skipped; completed in about 18 seconds.
  • make check-fmt
  • git diff --check

Is this a breaking change?

  • Yes
  • No

Does this PR include user facing changes?

  • Yes. Please add a changelog fragment based on our guidelines.
  • No. A maintainer will apply the no-changelog label to this PR.

References

@github-actions github-actions Bot added the domain: ci Anything related to Vector's CI environment label Aug 3, 2026
@cose-datadog

cose-datadog Bot commented Aug 3, 2026

Copy link
Copy Markdown

Tests

🎉 All green!

🧪 All tests passed
❄️ No new flaky tests detected

This comment will be updated automatically if new data arrives.
🔗 Commit SHA: 9198ef5 | Docs | Datadog PR Page | Give us feedback!

@pront pront added the no-changelog Changes in this PR do not need user-facing explanations in the release changelog label Aug 3, 2026
@pront
pront force-pushed the pront/commit-config-examples branch 2 times, most recently from 897adf5 to 61fcab1 Compare August 3, 2026 14:52
@pront
pront marked this pull request as ready for review August 3, 2026 16:29
@pront
pront requested a review from a team as a code owner August 3, 2026 16:29

@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: 61fcab1f40

ℹ️ 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/create-config-examples.js
Comment thread Makefile
Comment thread website/Makefile Outdated
@pront
pront force-pushed the pront/commit-config-examples branch from 61fcab1 to 9198ef5 Compare August 3, 2026 17:01
@pront
pront added this pull request to the merge queue Aug 3, 2026
Merged via the queue into master with commit 7e625d5 Aug 3, 2026
61 checks passed
@pront
pront deleted the pront/commit-config-examples branch August 3, 2026 18:36
@github-actions github-actions Bot locked and limited conversation to collaborators Aug 3, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

domain: ci Anything related to Vector's CI environment 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.

Commit example configs - Add examples validation to CI

2 participants