Skip to content

README: fail-on is policy, and belongs in .oasdiff.yaml - #219

Merged
reuvenharrison merged 1 commit into
mainfrom
readme-fail-on-is-policy
Nov 15, 2026
Merged

reuvenharrison merged 1 commit into
mainfrom
readme-fail-on-is-policy

Conversation

@reuvenharrison

Copy link
Copy Markdown
Contributor

Docs only. The README called the inputs facts about the run and .oasdiff.yaml the place for how oasdiff judges the API, then listed fail-on among the inputs. The severity that fails a job is judgment, not a fact about the run.

fail-on stays an input, so a workflow can block a merge without a second file, and the README now says that is why, and to set it in the file once there is one. No behavior change: the input still overrides the file.

🤖 Generated with Claude Code

The README called the inputs facts about the run and the file the place
for how oasdiff judges the API, then listed fail-on among the inputs. The
severity that fails a job is judgment. It stays an input so a workflow can
block a merge without a second file, and the README now says that.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
@reuvenharrison
reuvenharrison merged commit 8aad549 into main Nov 15, 2026
46 checks passed
@reuvenharrison
reuvenharrison deleted the readme-fail-on-is-policy branch November 15, 2026 18:49
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