Skip to content

Commit 1ea7f75

Browse files
docs: reflect OpenAPI 3.1 GA in CONTRIB; bump action version
Two stale items in CONTRIB.md: - Said "OpenAPI 3.1 support is in beta and needs real-world testing before general availability", but OPENAPI-31.md says it's been GA since v1.15.0. Reframes the section as "Report OpenAPI 3.1 issues" and drops the GA-decision tracking-issue bullet (decision was made). - The example workflow pinned oasdiff-action@v0.0.37; current is v0.0.44. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent d6526be commit 1ea7f75

1 file changed

Lines changed: 3 additions & 6 deletions

File tree

docs/CONTRIB.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,20 +16,17 @@ The simplest contribution is to use oasdiff in your projects and tell others abo
1616
If your team uses GitHub, install the [oasdiff GitHub Action](https://github.com/oasdiff/oasdiff-action) to automatically detect breaking changes on every pull request:
1717

1818
```yaml
19-
- uses: oasdiff/oasdiff-action/changelog@v0.0.37
19+
- uses: oasdiff/oasdiff-action/changelog@v0.0.44
2020
with:
2121
base: 'origin/${{ github.base_ref }}:openapi.yaml'
2222
revision: 'HEAD:openapi.yaml'
2323
```
2424
2525
The [Pro plan at oasdiff.com](https://www.oasdiff.com/pricing) adds a review workflow: each breaking change must be approved or rejected before the PR can merge.
2626
27-
## Test OpenAPI 3.1 (beta)
27+
## Report OpenAPI 3.1 issues
2828
29-
OpenAPI 3.1 support is in beta and needs real-world testing before general availability. See [OPENAPI-31.md](OPENAPI-31.md) for installation instructions and what's covered.
30-
31-
- Found an issue? [Open a bug report](https://github.com/oasdiff/oasdiff/issues/new?template=bug_report.md&title=[3.1]%20) with `[3.1]` in the title.
32-
- Working well? Add a 👍 to the [tracking issue](https://github.com/oasdiff/oasdiff/issues/52) and describe your use case — this directly informs the GA decision.
29+
OpenAPI 3.1 support is generally available, but the surface is large and edge cases come up. See [OPENAPI-31.md](OPENAPI-31.md) for what's covered and known caveats. If you hit something that doesn't behave as expected, [open a bug report](https://github.com/oasdiff/oasdiff/issues/new?template=bug_report.md&title=[3.1]%20) with `[3.1]` in the title.
3330

3431
## Improve the project
3532

0 commit comments

Comments
 (0)