https://github.com/oasdiff/github-demo
https://github.com/oasdiff/github-demo
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/oasdiff/github-demo
- Owner: oasdiff
- Created: 2024-07-04T14:07:42.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-25T20:35:29.000Z (about 1 year ago)
- Last Synced: 2025-06-07T07:41:56.924Z (8 months ago)
- Size: 16.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Demo of using oasdiff in a github workflow
This repo demonstrates how to use [oasdiff](https://github.com/Tufin/oasdiff) to check every change to an OpenAPI spec for breaking changes.
The [github workflow](https://github.com/oasdiff/github-demo/blob/main/.github/workflows/bc.yml) uses oasdiff to create a changelog which is displayed in the [GitHub Actions Summary](https://github.com/oasdiff/github-demo/actions/runs/9797247511).
Alternatively, you may use the [oasdiff-action](https://github.com/oasdiff/oasdiff-action).