Skip to content

feat: adding docs change validation step in reuseable CI #390

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

siddharth-khatsuriya
Copy link
Contributor

@siddharth-khatsuriya siddharth-khatsuriya commented Mar 27, 2025

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 required
  • push trigger tests
  • manual release test
  • automated releases test
  • pull request trigger tests
  • schedule trigger tests
  • workflow errors/warnings reviewed and addressed

Testing done

(for each selected checkbox, the corresponding test results link should be listed here)

@siddharth-khatsuriya siddharth-khatsuriya requested a review from a team as a code owner March 27, 2025 07:33
@siddharth-khatsuriya siddharth-khatsuriya force-pushed the feat/ADDON-78361-add-doc-change-validations branch 5 times, most recently from d248676 to 7bb8e3d Compare March 28, 2025 10:50
@siddharth-khatsuriya siddharth-khatsuriya force-pushed the feat/ADDON-78361-add-doc-change-validations branch from 7bb8e3d to 9d25098 Compare March 28, 2025 10:51
@siddharth-khatsuriya siddharth-khatsuriya force-pushed the feat/ADDON-78361-add-doc-change-validations branch from d54615e to 4cd10a5 Compare April 22, 2025 07:53
@siddharth-khatsuriya siddharth-khatsuriya force-pushed the feat/ADDON-78361-add-doc-change-validations branch from e912ba7 to c026201 Compare April 23, 2025 07:59
pawel-dabro
pawel-dabro previously approved these changes Apr 24, 2025
@siddharth-khatsuriya siddharth-khatsuriya force-pushed the feat/ADDON-78361-add-doc-change-validations branch from c6b3714 to e6f3bf8 Compare April 25, 2025 07:07
@siddharth-khatsuriya siddharth-khatsuriya merged commit e30a821 into develop Apr 25, 2025
6 checks passed
@siddharth-khatsuriya siddharth-khatsuriya deleted the feat/ADDON-78361-add-doc-change-validations branch April 25, 2025 11:55
@github-actions github-actions bot locked and limited conversation to collaborators Apr 25, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants