apache / apache/accumulo-proxy

Ensure proxy only uses public API before release

Open
#6 2 comments 1 reaction 0 assignees View on GitHub
blocker
Dominant language
Java
Stars
11
Forks
21
PR merge metrics
No merged PRs in 30d

Description

When the proxy was released with Accumulo it was ok if used non-public API Accumulo code because there was a one to one correspondence between the versions. Now that it is on an independent release schedule it should ideally only uses [Accumulo's public API](https://accumulo.apache.org/api/) because this will ensure releases of the proxy work with any version of Accumulo >= 2.0.

A first step in implementing this would be to update the pom to check the proxy source code to ensure only public API is used. For an example of how to do this see [pom.xm line 194](https://github.com/apache/accumulo-examples/blob/007c4ca0620834dcef5debaa6eee16d132501c02/pom.xml#L194), [contrib/checkstyle.xml](https://github.com/apache/accumulo-examples/blob/007c4ca0620834dcef5debaa6eee16d132501c02/contrib/checkstyle.xml), and [contrib/import-control.xml](https://github.com/apache/accumulo-examples/blob/007c4ca0620834dcef5debaa6eee16d132501c02/contrib/import-control.xml) in accumulo examples. As a first step we could add the checks to the pom with exceptions for any current non-api usage. This would prevent new non-api usage from being added while we work on removing all non-api usage.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.