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

Move to SmallRye #124

Closed
Ladicek opened this issue Jul 27, 2021 · 10 comments
Closed

Move to SmallRye #124

Ladicek opened this issue Jul 27, 2021 · 10 comments
Assignees
Labels
breaking-change Changes that break API backwards compatibility
Milestone

Comments

@Ladicek
Copy link
Contributor

Ladicek commented Jul 27, 2021

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.

@Ladicek Ladicek added this to the 3.0.0 milestone Jul 27, 2021
@darranl
Copy link

darranl commented Jul 27, 2021

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

@Ladicek
Copy link
Contributor Author

Ladicek commented Jul 27, 2021

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 :-)

@darranl
Copy link

darranl commented Jul 27, 2021

+1 whenever makes more sense.

@Ladicek Ladicek added the breaking-change Changes that break API backwards compatibility label Aug 23, 2021
@gastaldi
Copy link
Contributor

@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)?

@Ladicek
Copy link
Contributor Author

Ladicek commented Aug 24, 2021

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 :-)

@Ladicek
Copy link
Contributor Author

Ladicek commented Aug 27, 2021

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 :-)

@Ladicek
Copy link
Contributor Author

Ladicek commented Sep 7, 2021

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.

@Ladicek
Copy link
Contributor Author

Ladicek commented Jun 22, 2022

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.

@jonathanlermitage
Copy link

If my understanding is correct, we can consider the org.jboss.jandex group-id moved to io.smallrye.jandex?
I'm working on Maven oga plugin, a plugin that alerts developers when an artifact moved to new coordinates, but the affected pom files do not offer the relocation information. This is based on a huge list of coordinates migrations and, I would like to know your opinion before adding the migration rule(s) for Jandex. Thanks!

@Ladicek
Copy link
Contributor Author

Ladicek commented Jan 2, 2024

If my understanding is correct, we can consider the org.jboss.jandex group-id moved to io.smallrye.jandex?

No. The artifacts are moved like this:

org.jboss:jandex -> io.smallrye:jandex
org.jboss.jandex:jandex-maven-plugin -> io.smallrye:jandex-maven-plugin

See https://smallrye.io/blog/jandex-3-0-0/ for more.

I'm working on Maven oga plugin, a plugin that alerts developers when an artifact moved to new coordinates, but the affected pom files do not offer the relocation information.

We do have relocations in place for org.jboss:jandex. Does it not work?

This is based on a huge list of coordinates migrations and, I would like to know your opinion before adding the migration rule(s) for Jandex.

See above.

Thanks for reaching out, please let me know if you need more information!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking-change Changes that break API backwards compatibility
Projects
None yet
Development

No branches or pull requests

4 participants