Skip to content

Clarify description of JDK Transport modules#1767

Merged
kwin merged 1 commit intomasterfrom
feature/clarify-jdk-transport-description
Jan 28, 2026
Merged

Clarify description of JDK Transport modules#1767
kwin merged 1 commit intomasterfrom
feature/clarify-jdk-transport-description

Conversation

@kwin
Copy link
Member

@kwin kwin commented Jan 27, 2026

Following this checklist to help us incorporate your
contribution quickly and easily:

  • Your pull request should address just one issue, without pulling in other changes.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Each commit in the pull request should have a meaningful subject line and body.
    Note that commits might be squashed by a maintainer on merge.
  • Write unit tests that match behavioral changes, where the tests fail if the changes to the runtime are not applied.
    This may not always be possible but is a best-practice.
  • Run mvn verify to make sure basic checks pass.
    A more thorough check will be performed on your pull request automatically.
  • You have run the integration tests successfully (mvn -Prun-its verify).

If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.

To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.

@kwin
Copy link
Member Author

kwin commented Jan 27, 2026

For me also the names and artifactIds are confusing. Should IMHO contain "http". Otherwise it is hard to separate from transport-file (which is jdk/jre only as well). Also not sure about JDK vs JRE. For me this should be rather the latter as this is no feature exclusive to the JDK, so I would propose artifactId maven-resolver-transporter-http-java and name Maven Artifact Resolver Transporter HTTP with Java Client. @cstamas WDYT?

Also transport vs transporter is not quite clear. For me the SPI name is transporter, so should be impls of that SPI. Transport for me rather refers to the scheme/protocol.

@kwin kwin added the documentation Improvements or additions to documentation label Jan 27, 2026
@cstamas
Copy link
Member

cstamas commented Jan 27, 2026

We followed the module naming from old Resolver 1.x and I did not want to change them (the GAVs). For naming in POM, I agree but don't find it relevant. Finally, we have 4 transports capable of HTTP, so this will make really long (and hard to distinguish) module names like resolver-transport-http-java?

@kwin
Copy link
Member Author

kwin commented Jan 28, 2026

Any concerns with just changing the descriptions for now (i.e. merge the PR as is)?

@kwin kwin marked this pull request as ready for review January 28, 2026 17:24
@kwin kwin merged commit 700fcb0 into master Jan 28, 2026
21 checks passed
@kwin kwin deleted the feature/clarify-jdk-transport-description branch January 28, 2026 17:24
@github-actions github-actions bot added this to the 2.0.15 milestone Jan 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants