docs: document oasdiff.yaml config-file support in free actions#110
Merged
reuvenharrison merged 1 commit intomainfrom May 8, 2026
Merged
docs: document oasdiff.yaml config-file support in free actions#110reuvenharrison merged 1 commit intomainfrom
reuvenharrison merged 1 commit intomainfrom
Conversation
The free actions (diff, breaking, changelog) are CLI wrappers; the underlying CLI already looks up oasdiff.yaml from cwd, and GitHub Actions sets the runner cwd to $GITHUB_WORKSPACE. So drop oasdiff.yaml at the repo root and the actions pick it up automatically. Adds a "Configuring with oasdiff.yaml" section under Free actions with a runnable example, the precedence rule (action inputs override YAML), and the boolean-only-enable-via-input limitation as a footnote.
3 tasks
reuvenharrison
added a commit
that referenced
this pull request
May 8, 2026
…ng (#111) Three follow-up tweaks to #110: - Add a Contents TOC at the top so readers can jump to the right section in a now-sizeable README. - Move the "Configuring with oasdiff.yaml" subsection from the start of "Free actions" to the end, so readers see the three actions first and discover the shared config option after. - Fix wording in the Limitation note: the previous version said "boolean flags can only be enabled through an action input" but also "passing composed: 'false' has no effect", which is contra- dictory. The new wording — "action inputs can only turn a boolean flag on, not off" — describes what the entrypoint actually does.
3 tasks
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.
Summary
Documents that the free actions (
diff,breaking,changelog) inheritoasdiff.yamlfrom the repo root automatically — no extra wiring needed.Why
The free actions are CLI wrappers. The CLI already looks up
oasdiff.yamlfrom cwd, and GitHub Actions sets the runner cwd to$GITHUB_WORKSPACE(the checked-out repo root). So droppingoasdiff.yamlat the repo root just works — but nothing in the README told users that.What's in the diff
A new "Configuring with
oasdiff.yaml" section under "Free actions" with:CONFIG-FILES.mdfor the full referenceinputs:override config-file values)composed: truetofalse, edit the YAMLTest plan
CONFIG-FILES.mdresolves