docs: modernize the action README (new Pro workflow, checkout v7, versioning)#179
Merged
Conversation
reuvenharrison
force-pushed
the
docs-new-pro-workflow
branch
2 times, most recently
from
e89880e to
c3dd7c2
Compare
reuvenharrison
changed the title
The Pro section showed the legacy pr-comment action. The current Pro model is the changelog action with an oasdiff-token: same workflow as the free changelog, plus the token and statuses: write, which turns the review into approve/reject + an `oasdiff` commit-status gate. - Replace "Pro: Rich PR comment" with "Pro: Approve and gate changes", leading with the upgrade story (you already run changelog; add your token). Matches the workflow w3 generates on /setup. - Repoint the verify example's review job from pr-comment to changelog, add the permissions block, bump checkout to v7. - Update the table of contents. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
reuvenharrison
force-pushed
the
docs-new-pro-workflow
branch
from
c3dd7c2 to
ac8aadf
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
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.
Comprehensive README refresh. (Supersedes #178 — this branch ended up containing its commits, so #178 can be closed once this merges.)
Pro workflow (the main change)
The Pro section documented the legacy
pr-commentaction. The current Pro model is thechangelogaction with anoasdiff-token— the same workflow the site generates on/setup. Replaced "Pro: Rich PR comment" with "Pro: Approve and gate changes", led by the upgrade story: you already run the freechangelogaction; addOASDIFF_TOKEN(+statuses: write) and you get approve/reject per change and anoasdiffcommit-status check that gates the merge. CTAs to/start-trialand/pricing.Removed "Pro: Verify your setup"
verifyis only relevant to the advanced OAuth/App mode (an Enterprise option), not the default Pro (option-1) path, so it doesn't belong in the Pro docs.Also (from the folded-in #178 commits)
actions/checkout@v6→ v7 everywhere.pr-comment/verifystill ship (their badges and the.oasdiff.yamlaction list are unchanged); they're just no longer documented as the Pro path.