Skip to content

Move docs YAML validation to lightweight docs-lint workflow#1178

Open
arska wants to merge 1 commit intomasterfrom
add-docs-yaml-validation
Open

Move docs YAML validation to lightweight docs-lint workflow#1178
arska wants to merge 1 commit intomasterfrom
add-docs-yaml-validation

Conversation

@arska
Copy link
Copy Markdown
Member

@arska arska commented Mar 23, 2026

Summary

Move the docs YAML validation out of the e2e suite into the existing docs-lint.yml workflow as a separate lightweight job:

  • Uses a minimal KIND cluster (CRDs only, no operator/minio) — ~2 minutes vs 20+ for full e2e
  • Only triggers on docs/** changes
  • Validates both standalone example files and extracted inline YAML blocks with --dry-run=server
  • Removes test-99-docs-examples.bats from the e2e suite

Why

Doc-only PRs don't need the full e2e test infrastructure. The previous approach ran docs validation as part of the 20-minute e2e suite, which was slow and often hit flaky test failures unrelated to docs.

Relates-to: #1101

Test plan

  • Verify docs-lint workflow runs on doc changes
  • Verify KIND + CRD setup validates YAML correctly
  • Verify e2e suite no longer includes docs validation test

🤖 Generated with Claude Code

@arska arska requested a review from a team as a code owner March 23, 2026 11:29
@arska arska requested review from TheBigLee and tobru and removed request for a team March 23, 2026 11:29
@arska arska added enhancement New feature or request documentation This issue or pull request affects documentation labels Mar 23, 2026
@arska arska self-assigned this Mar 23, 2026
@arska arska force-pushed the add-docs-yaml-validation branch 2 times, most recently from fa042c2 to 6dab5ca Compare March 23, 2026 13:41
The docs YAML validation doesn't need a full KIND cluster — it
only needs CRDs for server-side dry-run. Move it to the existing
docs-lint workflow as a separate job that:
- Installs CRDs via kubectl apply (no KIND needed)
- Validates standalone and inline YAML examples
- Runs in ~30 seconds vs 20+ minutes for full e2e

This avoids triggering the slow e2e suite for doc-only changes.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Signed-off-by: Aarno Aukia <aarno.aukia@vshn.ch>
@arska arska force-pushed the add-docs-yaml-validation branch from 6dab5ca to 4633f66 Compare March 23, 2026 13:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation This issue or pull request affects documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant