fix: use doc context in github comment docDigest #571
Merged
Conversation
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
fbraure
reviewed
Dec 16, 2025
paulRbr
force-pushed
the
improve-doc-digest
branch
from
dac5682 to
e5d2b98
Compare
fbraure
approved these changes
Dec 16, 2025
Contributor
fbraure
left a comment
fbraure
left a comment
There was a problem hiding this comment.
Nice ! Thanks for the catch and the fix 🙏
This commit includes more information in the current “docDigest” which is used to differentiate github diff comments for each docs that are diffed with the github action. We had the “hub” context encoded in the digest, but forgot the “branch” name. This could lead to an inconsistant comment if one tries to execute two diff commands, with two differnt branch name. Only the second diff comment would be visible on the PR (instead of two comments one for each branch). The commit also moves the “doc digest” computation inside the `Repo` class instead of the main code.
paulRbr
force-pushed
the
improve-doc-digest
branch
from
e5d2b98 to
b74f4d9
Compare
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.
This commit includes more information in the current “docDigest” which
is used to differentiate github diff comments for each docs that are
diffed with the github action.
We had the “hub” context encoded in the digest, but forgot the
“branch” name. This could lead to an inconsistant comment if one tries
to execute two diff commands, with two differnt branch name. Only the
second diff comment would be visible on the PR (instead of two
comments one for each branch).
The commit also moves the “doc digest” computation inside the
Repoclass instead of the main code.