feat: adding docs change validation step in reuseable CI #390
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.
Description
Added a new job validate-docs-change.
This job will attempt to serve the documentation and fail if there are any errors.
If errors occur, they will be printed in the check logs step.
Another stage, enforce-docs-changes, reviews the result of validate-docs-change and uses run metadata to determine whether the job should fail the pipeline.
When the PR targets the main branch, enforce-docs-changes will enforce failure on broken documentation and block merge.
For other branches, it serves as an indicator of documentation issues without blocking the merge.
Checklist
README.md
has been updated or is not requiredTesting done
(for each selected checkbox, the corresponding test results link should be listed here)