Skip to content

Commit 8b9296c

Browse files
Update README.md
1 parent 7aba563 commit 8b9296c

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

Diff for: README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,5 @@
11
## Demo of using oasdiff in a github workflow
2-
Go to actions and see the summary
2+
This repo demonstrates how to use [oasdiff](https://github.com/Tufin/oasdiff) to check every change to an OpenAPI spec for breaking changes.
3+
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).
4+
5+
Alternatively, you may use the [oasdiff-action](https://github.com/oasdiff/oasdiff-action).

0 commit comments

Comments
 (0)