[ci] Add failure notification for package docs validation#18034
Merged
theletterf merged 5 commits intomainfrom Mar 25, 2026
Merged
[ci] Add failure notification for package docs validation#18034theletterf merged 5 commits intomainfrom
theletterf merged 5 commits intomainfrom
Conversation
- Remove continue-on-error from validate-package-docs so it properly blocks PRs with doc issues - Add a separate workflow_run-triggered workflow that posts a comment mentioning @elastic/ingest-docs when validation fails - The notification workflow uses workflow_run (runs in base branch context) so it can safely have pull-requests: write without exposing secrets to fork PRs Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
The validation step stays non-blocking (continue-on-error: true) but uploads a "docs-validation-failed" artifact when docs-builder exits non-zero. The notification workflow downloads this artifact — if it exists, it posts a PR comment mentioning @elastic/ingest-docs. This avoids false blocking on unknown edge cases while still surfacing doc issues to the right team. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Member
Author
|
+CC @mrodm |
mrodm
reviewed
Mar 25, 2026
- Use env var for github.event.pull_request.number instead of inline interpolation in shell (validate-package-docs.yml) - Use env var for github.repository instead of inline interpolation in shell (notify-package-docs-failure.yml) - Use --body-file instead of --body for multi-line comment to avoid shell quoting issues Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Member
Author
|
@mrodm Feedback addressed, please have another look |
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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
2 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
notify-package-docs-failure.yml) that comments on PRs when docs-builder validation finds errors, mentioning@elastic/ingest-docscontinue-on-error: true) to avoid false blocking on unknown edge casesHow it works
validate-package-docs.ymlworkflow runs docs-builder against changed package docsdocs-validation-failedartifact containing the PR numberworkflow_run-triggered workflow (notify-package-docs-failure.yml) downloads the artifact and posts a PR commentWhy
workflow_run?The validation workflow only has
contents: read(safe forpull_requestfrom forks). The notification needspull-requests: writeto comment.workflow_runalways runs in the base branch context, so it can safely hold write permissions without exposing secrets.🤖 Generated with Claude Code