Skip to content

README: one action for the run, .oasdiff.yaml for the rest - #218

Merged
reuvenharrison merged 2 commits into
mainfrom
readme-one-action
Nov 15, 2026
Merged

reuvenharrison merged 2 commits into
mainfrom
readme-one-action

Conversation

@reuvenharrison

@reuvenharrison reuvenharrison commented Nov 15, 2026 •

Copy link
Copy Markdown
Contributor

Docs only, following #214 to #217.

  • One list of inputs. breaking and changelog each carried a table of about twenty inputs, most of them oasdiff flags. breaking now lists the ten that describe a run (specs, fail-on, tokens, review, config, output-to-file, composed, allow-external-refs), and changelog refers to that list.
  • The rest is configuration. Ignore files, severity levels, flatten-allof, exclusions, deprecation windows, level, format and the other oasdiff flags are pointed at .oasdiff.yaml, where the same file gives the same answer locally. The inputs of those names still work and say so in one sentence; nothing is removed from the actions.
  • changelog is described as what it now is: the same action reporting every change.
  • config input replaces the OASDIFF_CONFIG example for breaking and changelog.
  • Examples no longer pass github-token, which has defaulted to the job's token all along.
  • Pull requests from forks get their own section: what still works, where the review link goes, and why pull_request_target is the wrong way to get a comment on them.
  • A broken example. The severity-levels sample listed api-version-not-bumped and api-major-version-not-bumped, which oasdiff v1.38.0 retired, so a file copied from the README failed to load. It now uses two ids that exist, checked against the v1.38.0 binary.

🤖 Generated with Claude Code

reuvenharrison and others added 2 commits November 15, 2026 20:40
Says what the inputs are for and what belongs in .oasdiff.yaml, describes
changelog as the breaking action reporting every change, documents the
config input in place of the OASDIFF_CONFIG example, and adds a section on
pull requests from forks, including why pull_request_target is the wrong
way to get a comment on them.

The severity-levels example listed api-version-not-bumped and
api-major-version-not-bumped, which oasdiff v1.38.0 retired: a file naming
them no longer loads. It now uses two ids that exist.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
…yaml

breaking and changelog each carried a table of about twenty inputs, most
of them oasdiff flags. breaking now lists the ten inputs that describe a
run, changelog refers to that list, and the flag-shaped options are named
as configuration that belongs in .oasdiff.yaml. The examples no longer
pass github-token, which defaults to the job's token.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
@reuvenharrison
reuvenharrison merged commit 751dbf8 into main Nov 15, 2026
46 checks passed
@reuvenharrison
reuvenharrison deleted the readme-one-action branch November 15, 2026 18:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant