[ci] Add blocking PR check for package docs using docs-builder#17879
Open
theletterf wants to merge 4 commits intomainfrom
Open
[ci] Add blocking PR check for package docs using docs-builder#17879theletterf wants to merge 4 commits intomainfrom
theletterf wants to merge 4 commits intomainfrom
Conversation
Adds a new workflow that validates changed packages/**/docs/*.md files
on every PR using the elastic/docs-builder action (metadata-only + strict
mode), catching Elastic-specific syntax issues before they reach EPR/downstream.
_dev/build/ template files are excluded since they contain {{ fields }}
syntax that is not valid docs-builder input.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Contributor
Author
|
+CC @elastic/docs-engineering @elastic/integration-docs |
Mpdreamz
approved these changes
Mar 18, 2026
shmsr
approved these changes
Mar 18, 2026
mjwolf
reviewed
Mar 18, 2026
Narrows the path trigger from packages/**/docs/** to packages/**/docs/*.md and tightens the grep filter to [^/]*.md$ so only top-level docs files are validated, excluding knowledge_base/ and other subdirectories. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Contributor
Author
|
Good catch — fixed in the latest commit. Both the path trigger and the grep filter now exclude subdirectories under |
Contributor
Author
|
@elastic/ecosystem Please have a look, thanks! |
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
4 participants
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
.github/workflows/validate-package-docs.yml— a new blocking PR check that runselastic/docs-builder(metadata-only + strict mode) against anypackages/**/docs/*.mdfiles changed in a PRdocset.ymlat the repo root listing only the changed files, so no static manifest needs to be maintained_dev/build/paths (those contain{{ fields }}template syntax not valid for docs-builder)Why
Vale linting already runs but is non-blocking (
fail_on_error: false). Badly formatted Markdown or invalid docs-builder directives can slip intopackages/*/docs/README.mdfiles and break downstream consumers (EPR /integration-docsrepo) silently. This check catches those issues at PR time.Test plan
packages/*/docs/README.mdwith intentionally broken Markdown — confirmValidate Package Docs (docs-builder)check appears and fails🤖 Generated with Claude Code