docs: configuring oasdiff with .oasdiff.yaml#115
Merged
Conversation
Add a Configuring section to the README explaining that all four actions pick up .oasdiff.yaml from the checked-out repo root. Cover: - the example shape with common keys (fail-on, exclude-elements, err-ignore) - precedence (action input > YAML > defaults) - legacy oasdiff.yaml fallback - OASDIFF_CONFIG override for non-default paths - cross-link to oasdiff/docs/CONFIG-FILES.md for the full reference Available since action v0.0.47 (oasdiff v1.15.3).
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
Add a "Configuring with
.oasdiff.yaml" section to the README, explaining that all four actions (breaking,changelog,diff,pr-comment) automatically pick up.oasdiff.yamlfrom the checked-out repo root.What it covers
fail-on,exclude-elements,err-ignore).with:input >.oasdiff.yaml> built-in defaults.oasdiff.yamlfilename still works as a back-compat fallback; new projects should prefer the dotfile name.OASDIFF_CONFIGenv var for configs that live outside the repo root.Notes the feature is available since action
v0.0.47(which ships oasdiffv1.15.3).Why now
The action is about to be tagged
v0.0.47. The corresponding oasdiffv1.15.3introduces the.oasdiff.*filename and--config/OASDIFF_CONFIGoverrides. Action users currently have no documented path for using a config file with the action.