[GitHub] tinkerpop pull request #494: TINKERPOP-1443 - Introduce API check into the b...

[metlos]

Github user metlos closed the pull request at:

https://github.com/apache/tinkerpop/pull/494


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] tinkerpop pull request #494: TINKERPOP-1443 - Introduce API check into the b...

[metlos]

GitHub user metlos opened a pull request:

https://github.com/apache/tinkerpop/pull/494

TINKERPOP-1443 - Introduce API check into the build

This introduces API checks into the build and fails the build whenever a 
"severe" change is introduced that would break either source or binary 
compatibility.

Several modules are excluded from the API check (by setting the 
`revapi.skip` property to true) but because I don't know exactly what Tinkerpop 
considers its public API this list might shrink or grow...

The API analysis itself is configured such that it only checks classes from 
`org.apache.tinkerpop` package and subpackages excluding 
`org.apache.tinkerpop.shaded`.

More importantly, the analysis is configured to allow breaking changes on a 
new minor version - from the context I gathered that is roughly your policy.

Also using a non-public class as part of the API always breaks the build 
even if other breaking changes are allowed.

As it stands right now, the CI build will fail with this PR because there 
are API changes that the checker disallows.

You can merge this pull request into a Git repository by running:

$ git pull https://github.com/metlos/tinkerpop api-check-tp32

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/tinkerpop/pull/494.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

This closes #494


commit f35041fe52173f4ce73ad4385d1ad011306e3df1
Author: Lukas Krejci 
Date:   2016-11-14T22:55:23Z

Introduce Revapi API checks into the build.

The API checker is set up to only check classes in org.apache.tinkerpop
package (and sub packages) and is set up to ignore breaking changes
on a minor version increase.

It always reports non-public classes that leak into the API though.

commit 992800be33d28f55372cb219e90447dd4f33accb
Author: Lukas Krejci 
Date:   2016-11-15T08:57:59Z

Merge remote-tracking branch 'upstream/tp32' into api-check




---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---