mvegter / openapi-diff-action

GitHub action to identify differences between Swagger or OpenApi specifications.

Hi there 👋

openapi-diff-action's Issues

Should fail CI on API breaking change

Hi and thank you for this gh-action!

I am looking at your implementation and it seems that it won't fail the CI job if an API breaking change is found. The doc doesn't mention what it the use-case it currently covers.

Can you please confirm if it will fail the CI job if an API breaking change is found?

Screenshot/Usage Example

This looks interesting but I'm fairly new to GitHub Actions so I'm not sure if I should be adding this to my repository or not.
My repository contains just a single OpenAPI yaml file so I think it does fit the use-case, but I would just like to be sure.

I'll probably set up a test repository and try out the Action on that, if all goes well, would you be okay with me raising a PR to update the README with a screenshot(s) ?

[Documentation] Example of result

Hi

I think it would be nice or even neccessary to add examples how the result of your diff (the comment on a PR) looks like so people know why (or why not) to use this acction.

One simple way to show this off is either using a PR on this repo itself that you reference in your README.

Even better would be a screenshot so one could see the action in "action" in the marketplace