docs: fix inaccurate write-mode descriptions in README#4
Merged
Conversation
Live-tested each upload write mode against a real PR: --print-only still creates a git blob/commit/ref (only the comment/body step is skipped), and --update-comment replaces the comment body rather than appending to it.
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
1 participant
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.
Summary
--print-onlywas documented as "no GitHub write," butupload_batchalways creates a blob/tree/commit and pushes torefs/uploads/<issue|pr>/<n>regardless of write mode — only the comment/body step is skipped. Wording now reflects that.--update-commentwas documented as "append," but it does a full PATCH replace of the comment body (update_commentinsrc/git_data_api.rs). Wording now says "replace."Testing
--print-onlystill writes a git ref, and--update-commentdrops prior content instead of appending. Original PR body/comment state was restored after testing.cargo test --release: 50 passed, 2 ignored (network-gated integration tests).