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 Wed, 06 Nov 2019 15:14:40 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_r343151016
 
 

 ##########
 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.
+
 
 Review comment:
   I think it would be really useful to add a sentence like the following.  This info is very
important.
   
   ```
   The techniques described in this blog post only work for Accumulo 2.0 and later.  Do not
use these with 1.X versions because those version have `impl` packages inside API packages
that must be excluded.  The needed exclusions for 1.X are not supported by import control.
   ```

----------------------------------------------------------------
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