smallrye / jandex

Java Annotation Indexer

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Move to SmallRye

Ladicek opened this issue · comments

For the 3.0 release, we want to move Jandex to SmallRye (and use the automated release process SmallRye has). Ideally, all Jandex repos (this one, the typeannotation-test, and the Maven plugin) would be brought into one (covered by #122).

The groupId would change from org.jboss[.jandex] to io.smallrye (or io.smallrye.jandex, but I'd probably prefer the first one :-) ). The artifactIds or packages wouldn't change (so packages would still be org.jboss.jandex), as that would be too big of a break.

EDIT: as part of this, also rename the master branch to main.

I don't think everyone will get the individual notifications from GitHub, maybe worth forwarding to the wildfly-dev list?

I agree, but I also think we should do that after the 2.4.0.Final release. I mean -- what I just added to the 2.4.0.Final milestone was originally referred to as 3.0. Then we decided we should call it 2.4, as there's nothing breaking, and do a 3.0 with some breakages that are needed (including this one). I think that makes most sense, but until that is actually done, I'd like to leave the door open :-)

+1 whenever makes more sense.

@Ladicek moving to Smallrye sounds like a wonderful idea, +1 to that. About the package name, I wonder if that wouldn't be an opportunity to introduce some major API changes (eg. introduce a new API under io.smallrye.jandex and keep the original API under org.jboss.jandex)?

I'm not sure we want to have 2 APIs. Also current implementation relies heavily on package-private methods, which precludes such split. I think we'll just live with some breaking changes :-)

We should also consider publishing relocations (https://maven.apache.org/guides/mini/guide-relocation.html). I'm not sure it's worth it, but David says it is :-)

All the changes required in the code base (groupId and parent POM) are now done on the smallrye branch. I'm not closing this issue because Jandex is still under the wildfly org. I believe we should transfer this repo to the smallrye org when the 3.0 release is almost ready. In the meantime, the changes for the 3.0 release should be done as PRs against the smallrye branch.

I just moved the Jandex repository to the smallrye GitHub org in preparation for a 3.0.0-RC1 release. Hence this is done for good.