ctubbsii commented on a change in pull request #206: Checkstyle import control blog post. Fixes #149 URL: https://github.com/apache/accumulo-website/pull/206#discussion_r342888610
########## File path: _posts/blog/2019-11-04-checkstyle-import-control.md ########## @@ -0,0 +1,93 @@ +--- +title: "Checking API use" +--- + +Accumulo follows [SemVer] across versions with the declaration of a public API. Code not in the public API should be +considered unstable, at risk of changing between versions. The packages included in the public API are [listed on the website][api] +but may not always be considered when developing using Accumulo code. This blog post explains how to setup a Maven project +to automatically detect when Accumulo 2.0 code used in the project is outside of the public API. + +## Checkstyle Plugin + +First add the checkstyle Maven plugin to your pom. + +```xml +<plugin> + <!-- This was added to ensure project only uses public API --> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-checkstyle-plugin</artifactId> + <version>3.1.0</version> + <configuration> + <configLocation>checkstyle.xml</configLocation> + </configuration> Review comment: There are different implications for putting this config here rather than in the execution section below. This config will be used even for manual runs of the plugin. I'm not sure that's the behavior we want to encourage people to use. Maybe move this config to the execution section below. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
