accumulo-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From GitBox <...@apache.org>
Subject [GitHub] [accumulo-website] keith-turner commented on a change in pull request #206: Checkstyle import control blog post. Fixes #149
Date Thu, 07 Nov 2019 15:37:18 GMT
keith-turner 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_r343717825
 
 

 ##########
 File path: _posts/blog/2019-11-04-checkstyle-import-control.md
 ##########
 @@ -0,0 +1,86 @@
+---
+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 public API packages are [listed
on the website][api]
+but may not be considered when an Accumulo user writes code.  This blog post explains how
to make Maven
+automatically detect usage of Accumulo code outside the public API.
+
+The techniques described in this blog post only work for Accumulo 2.0 and later.  Do not
use with 1.X versions.
+
+## Checkstyle Plugin
+
+First add the checkstyle Maven plugin to your pom.
+
+```xml
+<plugin>
+    <!-- This was added to ensure project only uses public API -->
 
 Review comment:
   ```suggestion
       <!-- This was added to ensure project only uses Accumulo's public API -->
   ```

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services

Mime
View raw message