redskap / swagger-brake

Swagger contract checker for breaking API changes
Apache License 2.0
58 stars 16 forks source link

Document usage as gradle/maven plugin #5

Closed simmel closed 5 years ago

simmel commented 5 years ago

If I understood your introducing blog-post this tool can be used in during the build in gradle or maven, is this correct?

If so, please document the usage in gradle and maven.

simmel commented 5 years ago

Ah, I found https://github.com/redskap/swagger-brake-example now but still might be in README?

galovics commented 5 years ago

Dear @simmel,

The article is coming out tomorrow about Gradle + Maven usage but here's a sneak peek: https://github.com/redskap/swagger-brake-maven-plugin https://github.com/redskap/swagger-brake-gradle

And example projects for them: https://github.com/redskap/swagger-brake-example

simmel commented 5 years ago

Ah, nice! I just found that the maven and gradle plugins are seperate projects! So maybe just mention and link to them in the docs then?

simmel commented 5 years ago

Nice work!

galovics commented 5 years ago

Readme is extended with the necessary information and references the plugin sites.