fix(docs): update existing solidity preview comments - #3
Merged
Conversation
mswilkison
marked this pull request as ready for review
September 10, 2026 18:41
Keep one workflow-owned preview comment per project across repeat runs. Test the shipped workflow script against a mocked GitHub API. Fixes #2
Match the workflow-owned preview comment by first line instead of a bare-LF prefix, so a comment edited in the GitHub web UI (CRLF line endings) is still updated instead of orphaning a stale copy. Document that overlapping runs for the same projectDir are not serialized, and pin the newline-agnostic match with a CRLF-body test. Gate the comment if-condition and the update payload assertions on the exact expected values.
piotr-roslaniec
force-pushed
the
fix/solidity-docs-preview-comments
branch
from
September 11, 2026 20:16
3e0c9c8 to
d5fc473
Compare
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.
Repeated Solidity docs runs now update the existing
github-actions[bot]preview comment for the sameprojectDir. A stable encoded marker separates projects, and paginated lookup leaves other users' comments and older unmarked comments untouched.commentPRremains disabled by default.Validation: all 22 tests and full ESLint pass using Node 16, matching
actions/github-script@v6. Nine mocked API tests execute the actual workflow script and cover creation, updates, multiple projects, ownership, pagination, input encoding, and lookup failures. Eight of those tests failed against the original workflow.Fixes #2.