From eb226688c1fa920ad572aea4b58b11b486704e24 Mon Sep 17 00:00:00 2001 From: Reuven Harrison Date: Sat, 18 Apr 2026 21:42:07 +0300 Subject: [PATCH 1/2] docs: point Pro section to Installation Wizard as single source of truth Replace scattered prerequisites and pricing links with a single "Getting started" link to the Installation Wizard. Remove github-token from the inputs table (GitHub App handles posting now). Clean up oasdiff-token description in action.yml to remove stale permissions. Co-Authored-By: Claude Sonnet 4.6 --- README.md | 7 +++---- pr-comment/action.yml | 2 +- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 35daa69..bc12826 100644 --- a/README.md +++ b/README.md @@ -172,7 +172,7 @@ When using git refs, you need to check out the repo and fetch the base branch: `oasdiff/oasdiff-action/pr-comment` posts a single auto-updating comment on every PR that touches your API spec. -**Prerequisite:** oasdiff posts comments and commit statuses as a GitHub App. [Install the oasdiff GitHub App](https://github.com/apps/oasdiff/installations/new) on each repository before using this action. +**Getting started:** The [oasdiff Installation Wizard](https://www.oasdiff.com/dashboard) walks you through signing up, installing the GitHub App, and adding the workflow to your repo. ```yaml name: oasdiff @@ -206,10 +206,9 @@ Each **Review** link opens a hosted page with a side-by-side spec diff and **App |---|---|---|---| | `base` | — (required) | Path to the base (old) OpenAPI spec | file path, URL, git ref | | `revision` | — (required) | Path to the revised (new) OpenAPI spec | file path, URL, git ref | -| `oasdiff-token` | — (required) | oasdiff API token — [get one at oasdiff.com/pricing](https://oasdiff.com/pricing) | — | -| `github-token` | `${{ github.token }}` | GitHub token for posting the PR comment; requires `pull-requests: write`, `statuses: write` | — | +| `oasdiff-token` | — (required) | oasdiff API token — set up via the [Installation Wizard](https://www.oasdiff.com/dashboard) | — | | `include-path-params` | `false` | Include path parameter names in endpoint matching | `true`, `false` | | `exclude-elements` | `''` | Exclude certain kinds of changes from the output | `endpoints`, `request`, `response` (comma-separated) | | `composed` | `false` | Run in composed mode | `true`, `false` | -An `OASDIFF_TOKEN` is issued per GitHub organization. [See pricing →](https://www.oasdiff.com/pricing) +Set up your token through the [oasdiff Installation Wizard →](https://www.oasdiff.com/dashboard) diff --git a/pr-comment/action.yml b/pr-comment/action.yml index eed1c29..11a6636 100644 --- a/pr-comment/action.yml +++ b/pr-comment/action.yml @@ -20,7 +20,7 @@ inputs: required: false default: 'false' oasdiff-token: - description: 'oasdiff API token (tenant ID). Required permissions: pull-requests: write, statuses: write' + description: 'oasdiff API token — set up via the Installation Wizard at oasdiff.com/dashboard' required: true github-token: description: 'GitHub token for posting PR comment' From 18f2c29f15362deabe471edbec9200e382bd05a7 Mon Sep 17 00:00:00 2001 From: Reuven Harrison Date: Sat, 18 Apr 2026 23:49:09 +0300 Subject: [PATCH 2/2] docs: point Pro section to /pricing, use real demo review links Update all Pro links to point to /pricing instead of /dashboard (wizard is being removed). Use actual review page links from the oasdiff/demo PR for the example table. Co-Authored-By: Claude Sonnet 4.6 --- README.md | 12 ++++++------ pr-comment/action.yml | 2 +- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index bc12826..5a64244 100644 --- a/README.md +++ b/README.md @@ -172,7 +172,7 @@ When using git refs, you need to check out the repo and fetch the base branch: `oasdiff/oasdiff-action/pr-comment` posts a single auto-updating comment on every PR that touches your API spec. -**Getting started:** The [oasdiff Installation Wizard](https://www.oasdiff.com/dashboard) walks you through signing up, installing the GitHub App, and adding the workflow to your repo. +**Getting started:** [Sign up for oasdiff Pro](https://www.oasdiff.com/pricing) to get your token, then follow the setup instructions to install the GitHub App, add your repo secret, and create the workflow. ```yaml name: oasdiff @@ -196,9 +196,9 @@ The comment shows a table of all changes, grouped by severity, with a **Review** | Severity | Change | Path | Review | |---|---|---|---| -| 🔴 | response-property-removed | `GET /users` | ✅ [Approved by @alice](https://oasdiff.com/review/…) | -| 🔴 | request-parameter-type-changed | `GET /products` | ⏳ [Review](https://oasdiff.com/review/…) | -| 🟡 | response-optional-property-removed | `POST /orders` | ⏳ [Review](https://oasdiff.com/review/…) | +| 🔴 | request parameter became required | `GET /products` | ⏳ [Review](https://www.oasdiff.com/review/4a9fd2d5-5ac2-42f5-94cb-c911d6d41680?highlight=a570278809fa) | +| 🔴 | api removed without deprecation | `DELETE /users/{userId}` | ⏳ [Review](https://www.oasdiff.com/review/4a9fd2d5-5ac2-42f5-94cb-c911d6d41680?highlight=bc9f61316c57) | +| 🔴 | request parameter type changed | `GET /users/{userId}` | ⏳ [Review](https://www.oasdiff.com/review/4a9fd2d5-5ac2-42f5-94cb-c911d6d41680?highlight=b9a23e767b29) | Each **Review** link opens a hosted page with a side-by-side spec diff and **Approve / Reject** buttons. Approvals are tied to the change fingerprint and carry forward automatically when the branch is updated. A commit status check blocks the merge until every breaking change has been reviewed. @@ -206,9 +206,9 @@ Each **Review** link opens a hosted page with a side-by-side spec diff and **App |---|---|---|---| | `base` | — (required) | Path to the base (old) OpenAPI spec | file path, URL, git ref | | `revision` | — (required) | Path to the revised (new) OpenAPI spec | file path, URL, git ref | -| `oasdiff-token` | — (required) | oasdiff API token — set up via the [Installation Wizard](https://www.oasdiff.com/dashboard) | — | +| `oasdiff-token` | — (required) | oasdiff API token — [sign up at oasdiff.com](https://www.oasdiff.com/pricing) | — | | `include-path-params` | `false` | Include path parameter names in endpoint matching | `true`, `false` | | `exclude-elements` | `''` | Exclude certain kinds of changes from the output | `endpoints`, `request`, `response` (comma-separated) | | `composed` | `false` | Run in composed mode | `true`, `false` | -Set up your token through the [oasdiff Installation Wizard →](https://www.oasdiff.com/dashboard) +[Get oasdiff Pro →](https://www.oasdiff.com/pricing) diff --git a/pr-comment/action.yml b/pr-comment/action.yml index 11a6636..e046b59 100644 --- a/pr-comment/action.yml +++ b/pr-comment/action.yml @@ -20,7 +20,7 @@ inputs: required: false default: 'false' oasdiff-token: - description: 'oasdiff API token — set up via the Installation Wizard at oasdiff.com/dashboard' + description: 'oasdiff API token — sign up at oasdiff.com/pricing' required: true github-token: description: 'GitHub token for posting PR comment'