Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consider migrating to API Guardian #112

Closed
alexander-yevsyukov opened this issue May 14, 2018 · 7 comments
Closed

Consider migrating to API Guardian #112

alexander-yevsyukov opened this issue May 14, 2018 · 7 comments

Comments

@alexander-yevsyukov
Copy link
Contributor

alexander-yevsyukov commented May 14, 2018

Now we use own annotations similar to one available in gRPC.
The advantage of migrating to API Guardian is simple: have the same set of annotations for all our code, which has the following implications:

  • Unified tooling. We can apply the same verification, testing, and documentation tools.
  • Unified learning: in each project people would use the same set of annotations.

I found this library via analyzing dependencies of NullAway. It's being used by JUnit 5.

@alexander-yevsyukov
Copy link
Contributor Author

@armiol, have a look at this issue. We need to decide on this soon. We sill will be able to change it after v1.0 release, but there are other products that may benefit from this decision too.

@alexander-yevsyukov
Copy link
Contributor Author

Recent communications from the people behind the project on deploying the artifact to Maven central.

Currently there's no site behind apiguardian.org. The comments for the issue confirm the ownership for the domain.

@armiol
Copy link
Collaborator

armiol commented May 14, 2018

I think that @SPI annotation is difficult to emulate with the number of options in API Guardian.

@SPI
public class AbstractEntity {...}

gives a proper intention, while

@API(status = Status.STABLE)
public class AbstractEntity {...}

has different semantics.

@alexander-yevsyukov
Copy link
Contributor Author

Agree. @SPI is a different thing, and may not be applicable to some of the projects. But the rest looks common.

@alexander-yevsyukov
Copy link
Contributor Author

And we may contact these guys asking for an extension.

@armiol
Copy link
Collaborator

armiol commented May 14, 2018

See apiguardian-team/apiguardian#11.

@alexander-yevsyukov
Copy link
Contributor Author

Assuming the API Guardian is not going to change, the migration looks impractical to us.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants