Skip to content

Commit daa39a7

Browse files
docs: revert oasdiff.yaml configuration section (#113)
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.
1 parent 18a94c3 commit daa39a7

1 file changed

Lines changed: 0 additions & 20 deletions

File tree

README.md

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ GitHub Actions for comparing OpenAPI specs and detecting breaking changes, based
1010
- [Check for breaking changes](#check-for-breaking-changes)
1111
- [Generate a changelog](#generate-a-changelog)
1212
- [Generate a diff report](#generate-a-diff-report)
13-
- [Configuring with `oasdiff.yaml`](#configuring-with-oasdiffyaml)
1413
- [Spec paths](#spec-paths)
1514
- [Pro: Rich PR comment](#pro-rich-pr-comment)
1615

@@ -156,25 +155,6 @@ jobs:
156155
| `flatten-allof` | `false` | Merge allOf subschemas into a single schema before diff | `true`, `false` |
157156
| `output-to-file` | `''` | Write output to this file path instead of stdout | file path |
158157

159-
### Configuring with `oasdiff.yaml`
160-
161-
All free actions inherit the CLI's config-file support. Drop an `oasdiff.yaml` at your repo root and the actions pick it up automatically — no extra wiring needed:
162-
163-
```yaml
164-
# oasdiff.yaml at your repo root
165-
exclude-elements:
166-
- endpoints
167-
flatten-allof: true
168-
deprecation-days-stable: 180
169-
fail-on: ERR
170-
```
171-
172-
Any flag the oasdiff CLI supports works in the config file — see [CONFIG-FILES.md](https://github.com/oasdiff/oasdiff/blob/main/docs/CONFIG-FILES.md) for the full reference and supported file formats (`oasdiff.{json,yaml,yml,toml,hcl}`).
173-
174-
Action `inputs:` take precedence over config-file values, so you can use the file for shared defaults across workflows and override per-workflow via inputs.
175-
176-
> **Limitation**: action inputs can only turn a boolean flag *on*, not *off*. If your `oasdiff.yaml` sets `composed: true`, passing `composed: 'false'` to the action has no effect — to disable it for a specific workflow run, edit the YAML.
177-
178158
---
179159

180160
## Spec paths

0 commit comments

Comments
 (0)