docs: revert oasdiff.yaml configuration section pending move to .oasdiff.*#113
Merged
reuvenharrison merged 1 commit intomainfrom May 8, 2026
Merged
Conversation
The documented path (oasdiff.yaml at the repo root) is unconventional for a CI/lint tool. Most tools in this category use a dotfile convention (.eslintrc, .prettierrc, .golangci.yml, .yamllint, etc.). Pulling the section so customers don't adopt the unconventional path and have to migrate later. The CLI lookup will move to .oasdiff.* in a follow-up; documentation will return at that point with the right path. Keeps the rest of the README intact: the TOC structure (only the line for this removed section is dropped), the boolean-limitation wording fix from #111, all action subsections.
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
Reverts the "Configuring with
oasdiff.yaml" subsection added in #110/#111. The documented filename (oasdiff.yamlat repo root) is unconventional for a CI/lint tool — most tools in this category use a dotfile (.eslintrc,.prettierrc,.golangci.yml,.yamllint,.flake8,.markdownlint.json).Pulling the docs section now so customers don't adopt the unconventional path during the brief window we recommended it. The CLI's config-file lookup will move to
.oasdiff.*in a follow-up; documentation will return at that point with the right path.What stays
Companion reverts
oasdiff/w3#???— same-shape revert of/docs/github-actionpage.oasdiff/oasdiff#???— drop the cross-link added toCONFIG-FILES.md.Test plan