Missing documentation on how to "Fail your build when a rule is violated"

[pauminku]

Hi, thanks for this great plugin. I'm trying to configure my project so it fails if a rule is violated, but even I see fatal errors in reports generated by ./gradlew ProjectGuardCheck, I can sync and run the project without issues. What I'm missing?

Thanks in advance.

[rubensousa]

Hi @pauminku

That task will fail if there are rules being violated. It was created to be dedicated gate in your CI/CD, instead of directly part of the build process.

The inclusion in the build process isn't done yet, if you're interested let me know and I'll add it in a next release

[rubensousa]

In your CI/CD, for now use ./gradlew projectGuardAggregateCheck. This will fail if there is a rule being violated

[rubensousa]

@pauminku this PR adds support for failing the build during check or assemble lifecycle tasks: #75

[rubensousa]

@pauminku will be released in 1.0.0-beta04