Add `PreventUsingIncubatingMethods` error-prone check (conjure) #1554

blacksmithgu · 2020-11-19T20:59:04Z

An explicit check which warns against using incubating APIs; you can disable it on a per-project basis, or on a per-usage basis using @SuppressWarnings.

Before this PR

Incubating APIs are a stability liability, and should generally only be used explicitly (i.e., opt-in instead of opt-out). This check prevents their usage without an explicit annotation or opt-out.

After this PR

Adds the PreventUsingIncubatingMethods error-prone check, which blocks methods annotated with Conjure's @Incubating annotation.

Possible downsides?

Users upgrading gradle-baseline may get errors related to incubating methods until they either disable the check or tag their incubating API usages.

@SuppressWarnings

An explicit check which warns against using incubating APIs; you can disable it on a per-project basis, or on a per-usage basis using @SuppressWarnings.

palantirtech · 2020-11-19T20:59:06Z

Thanks for your interest in palantir/gradle-baseline, @blacksmithgu! Before we can accept your pull request, you need to sign our contributor license agreement - just visit https://cla.palantir.com/ and follow the instructions. Once you sign, I'll automatically update this pull request.

changelog-app · 2020-11-19T20:59:09Z

Generate changelog in `changelog/@unreleased`

Type

Description

Add PreventUsingIncubatingMethods error-prone check (conjure)

An explicit check which warns against using incubating APIs; you can disable it on a per-project basis, or on a per-usage basis using @SuppressWarnings.

Before this PR

Incubating APIs are a stability liability, and should generally only be used explicitly (i.e., opt-in instead of opt-out). This check prevents their usage without an explicit annotation or opt-out.

After this PR

Adds the PreventUsingIncubatingMethods error-prone check, which blocks methods annotated with Conjure's @Incubating annotation.

Possible downsides?

Users upgrading gradle-baseline may get errors related to incubating methods until they either disable the check or tag their incubating API usages.

Check the box to generate changelog(s)

Generate changelog entry

blacksmithgu · 2020-11-19T21:04:44Z

cc @carterkozak

README.md

...rror-prone/src/main/java/com/palantir/baseline/errorprone/PreventUsingIncubatingMethods.java

To be more in line with other checks.

...rror-prone/src/main/java/com/palantir/baseline/errorprone/PreventUsingIncubatingMethods.java

baseline-error-prone/src/test/java/com/palantir/baseline/errorprone/IncubatingMethodTest.java

@Incubating

To ensure we get a compile break if @Incubating ever moves.

carterkozak

Lgtm, thanks!

svc-autorelease · 2020-11-20T00:28:19Z

Released 3.53.0

Add PreventUsingIncubatingMethods error-prone check

a373c08

An explicit check which warns against using incubating APIs; you can disable it on a per-project basis, or on a per-usage basis using @SuppressWarnings.

policy-bot bot requested a review from CRogers November 19, 2020 20:59