feat(github): add comment_key input for sticky PR/issue comments#1
Closed
0xLLLLH wants to merge 9 commits into
Closed
feat(github): add comment_key input for sticky PR/issue comments#10xLLLLH wants to merge 9 commits into
0xLLLLH wants to merge 9 commits into
Conversation
Add a new optional input to the GitHub Action. When set,
OpenCode upserts a single comment per issue/PR thread instead of creating
a new comment on every run.
- github/action.yml: add input, wire as COMMENT_KEY env var
- github.ts: export buildCommentKeyDigest and appendCommentAnchor pure
helpers; add commentKeyDigest(), findExistingStickyComment() and
publishComment() inside the run handler; replace all createComment()
call sites with publishComment()
- test: add unit tests for buildCommentKeyDigest and appendCommentAnchor
- docs: add Sticky comments section with usage table and key explanation;
update PR Example to include comment_key
Behaviour:
- COMMENT_KEY unset/blank → create a new comment every run (no change)
- COMMENT_KEY set → search current issue/PR for a bot comment
whose body contains
<!-- opencode:comment-key:sha256:<digest> -->
and update it; create if not found
- Multiple matches → update the most recent one, log a warning
|
This PR doesn't fully meet our contributing guidelines and PR template. What needs to be fixed:
Please edit this PR description to address the above within 2 hours, or it will be automatically closed. If you believe this was flagged incorrectly, please let a maintainer know. |
|
This pull request has been automatically closed because it was not updated to meet our contributing guidelines within the 2-hour window. Feel free to open a new pull request that follows our guidelines. |
Closed
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
Adds a new optional
comment_keyinput to the GitHub Action. When set, OpenCode upserts a single comment per issue/PR thread instead of posting a new comment on every run.Behaviour
comment_keyunset / blankcomment_keysetAnchor format
The key is sha256-hashed and embedded as an invisible HTML comment in the body:
This safely handles arbitrary characters in the key without escaping rules.
Usage
Changes
github/action.yml: addcomment_keyinput, wire asCOMMENT_KEYenv varpackages/opencode/src/cli/cmd/github.ts: exportbuildCommentKeyDigest/appendCommentAnchor; addpublishComment()upsert entrypoint; replace allcreateComment()call sitespackages/opencode/test/cli/github-action.test.ts: unit tests for the two new pure functionspackages/web/src/content/docs/github.mdx: Sticky comments section + updated PR example