Skip to content

Commit 24c0b8a

Browse files
Make the comment's opt-out findable: link to the docs Action section, name the upload
A user who got the comment via a moving action ref (not a deliberate opt-in) is the one most likely to want to turn it off. Two changes so they find how: - link 'oasdiff GitHub Action' to /docs/free-review#github-action, the section that explains what posted the comment and how to disable it; - reframe the off-switch from 'stop posting this comment' to 'turn this off (no spec upload, no comment)', since review: false stops the upload too, which is what a privacy-minded first-time reader actually wants. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent f60eb29 commit 24c0b8a

2 files changed

Lines changed: 2 additions & 2 deletions

File tree

breaking/entrypoint.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ The link expires in 7 days.
7070
7171
🔒 Your API specs are encrypted in CI before they're uploaded. The decryption key stays in this link's URL fragment (after the #), which browsers never send to a server, so oasdiff cannot read your specs. [How it works →](https://www.oasdiff.com/docs/free-review#privacy)
7272
73-
<sub>Posted automatically by the oasdiff GitHub Action. To stop posting this comment, set \`review: false\` on the action.</sub>"
73+
<sub>Posted automatically by the [oasdiff GitHub Action](https://www.oasdiff.com/docs/free-review#github-action). To turn this off (no spec upload, no comment), set \`review: false\` on the action.</sub>"
7474
elif [ -n "$existing_id" ]; then
7575
body="${marker}
7676
### ✅ No breaking changes in the latest revision."

changelog/entrypoint.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ The link expires in 7 days.
8989
9090
🔒 Your API specs are encrypted in CI before they're uploaded. The decryption key stays in this link's URL fragment (after the #), which browsers never send to a server, so oasdiff cannot read your specs. [How it works →](https://www.oasdiff.com/docs/free-review#privacy)
9191
92-
<sub>Posted automatically by the oasdiff GitHub Action. To stop posting this comment, set \`review: false\` on the action.</sub>"
92+
<sub>Posted automatically by the [oasdiff GitHub Action](https://www.oasdiff.com/docs/free-review#github-action). To turn this off (no spec upload, no comment), set \`review: false\` on the action.</sub>"
9393
elif [ -n "$existing_id" ]; then
9494
body="${marker}
9595
### ✅ No API changes in the latest revision."

0 commit comments

Comments
 (0)