From notifications-return-52896-archive-asf-public=cust-asf.ponee.io@accumulo.apache.org Thu Nov 7 15:37:19 2019 Return-Path: X-Original-To: archive-asf-public@cust-asf.ponee.io Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [207.244.88.153]) by mx-eu-01.ponee.io (Postfix) with SMTP id 7E307180630 for ; Thu, 7 Nov 2019 16:37:19 +0100 (CET) Received: (qmail 43689 invoked by uid 500); 7 Nov 2019 15:37:19 -0000 Mailing-List: contact notifications-help@accumulo.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: jira@apache.org Delivered-To: mailing list notifications@accumulo.apache.org Received: (qmail 43677 invoked by uid 99); 7 Nov 2019 15:37:18 -0000 Received: from ec2-52-202-80-70.compute-1.amazonaws.com (HELO gitbox.apache.org) (52.202.80.70) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 07 Nov 2019 15:37:18 +0000 From: GitBox To: notifications@accumulo.apache.org Subject: [GitHub] [accumulo-website] keith-turner commented on a change in pull request #206: Checkstyle import control blog post. Fixes #149 Message-ID: <157314103874.10475.9065272274186965929.gitbox@gitbox.apache.org> Date: Thu, 07 Nov 2019 15:37:18 -0000 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit 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 + + Review comment: ```suggestion ``` ---------------------------------------------------------------- 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