Commit efad245
Default github-token to github.token so the review comment posts without setup (#167)
* Default github-token to ${{ github.token }} so the PR comment posts without setup
Most repos got the encrypted free review by tracking a moving action ref,
not by a proactive upgrade, so they never added github-token + permissions.
Result: the review link goes only to the job summary (a page almost nobody
opens). Day-2 production: ~476 reviews created, 3 opened.
Defaulting github-token to the built-in github.token means the comment is
posted automatically wherever the job's GITHUB_TOKEN already has write
permission, with no workflow edit. Repos whose default token is read-only
still fall back to the summary (the permissions line genuinely needs a
workflow edit); fork PRs are unchanged.
Also makes the comment the honest first-touch notice it now is:
- precise privacy wording (key lives in the URL fragment, never sent to a
server, so oasdiff cannot read the specs) instead of "specs stay private";
- "anyone with the link can open" (the capability-by-URL model) instead of
"anyone can open";
- an explicit opt-out line ("set review: false") since the comment is now
posted by default.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
* Trim the review comment to essentials
Drop product-jargon ('in context'), the share prompt (the review page has a
per-change 'Copy link'), the 'anyone with the link' line (covered by the docs
'How it works' link), and 'no install or account needed' (self-evident on
click). Keep the title (the value), the 7-day TTL, the privacy explanation,
and the opt-out footer.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
* 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>
---------
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>1 parent 5fbe96e commit efad245
4 files changed
Lines changed: 12 additions & 8 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
61 | 61 | | |
62 | 62 | | |
63 | 63 | | |
64 | | - | |
| 64 | + | |
65 | 65 | | |
66 | | - | |
| 66 | + | |
67 | 67 | | |
68 | 68 | | |
69 | 69 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
66 | 66 | | |
67 | 67 | | |
68 | 68 | | |
69 | | - | |
| 69 | + | |
70 | 70 | | |
71 | | - | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
72 | 74 | | |
73 | 75 | | |
74 | 76 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
64 | 64 | | |
65 | 65 | | |
66 | 66 | | |
67 | | - | |
| 67 | + | |
68 | 68 | | |
69 | | - | |
| 69 | + | |
70 | 70 | | |
71 | 71 | | |
72 | 72 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
85 | 85 | | |
86 | 86 | | |
87 | 87 | | |
88 | | - | |
| 88 | + | |
89 | 89 | | |
90 | | - | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
91 | 93 | | |
92 | 94 | | |
93 | 95 | | |
| |||
0 commit comments