POC: add documentation delta reporting to PR checks - #794
Draft
AlexanderLanin wants to merge 2 commits into
Draft
Conversation
Contributor
|
Documentation preview for this pull request is available at: Documentation deltaBaseline: https://eclipse-score.github.io/docs-as-code/main Summary
NeedsRendered HTML pagesModified (5) |
Contributor
A bit confused by this. |
Member
Author
|
Yeah.... This is a non functional POC ;-) Enough to discuss the idea. |
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
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.
What this achieves
This POC adds an automated documentation delta report to same-repository pull request checks and publishes the result as a PR comment alongside the documentation preview.
Why this is necessary
Documentation changes are currently difficult to review from generated output alone. A concise comparison of Sphinx-Needs data and rendered HTML makes affected requirements and pages visible directly in the pull request. The baseline must come from the published documentation revision matching the PR base commit, rather than the latest
gh-pagespublication.Changes
docs_deltacomparison tool and regression tests.gh-pagesbaseline from GitHub Actions environment data.uvin the localon-pr.ymlworkflow.This is an exploratory POC and is not intended for merging.