[MNG-8097] Outline the two different ways to reference a dependency #529
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
(with a related artifact handler)
kwin
force-pushed
the
feature/clarify-dependency-types
branch
from
827787d to
87229d3
Compare
cstamas
reviewed
May 21, 2024
| different extension and a classifier. The type often corresponds to the packaging used, though this is | ||
| also not always the case. Some examples are <<<jar>>>, <<<ejb-client>>> and <<<test-jar>>>: | ||
| see {{{/ref/current/maven-core/artifact-handlers.html}default artifact handlers}} for a list. New types can be | ||
| defined by plugins that set <<<extensions>>> to true, so this is not a complete list. | ||
|
|
||
| In case there is an artifact handler defined there are <two> different ways of referencing the same dependency: |
There was a problem hiding this comment.
I find this very much mixed up and not quite comprehensive. @hboutemy
Issues:
- by removal of "filename", the term "extension" is suddenly changing it's meaning (maven extension? this was my first thought while trying to comprehend the message)
- did you maybe mix up the "former and latter"?
- I find this very confusing all in all. Type is type, why do you want to mixin here file extension?
There was a problem hiding this comment.
by removal of "filename", the term "extension" is suddenly changing it's meaning (maven extension? this was my first thought while trying to comprehend the message)
you kind of said the opposite in apache/maven#1466 (comment). This is the extension of the artifact which is not necessarily the extension of the filename!
The depensency extension is told by type. Deoendency is never "anywhere on disk", it may come from repo only.
or in apache/maven#1466 (comment)
It is artifact that you need to inspect, not the backing file.
yes, good catch will fix.
I find this very confusing all in all. Type is type, why do you want to mixin here file extension
First of all, there was a mention of file extension before this PR, with this PR I only refer to artifact extension (do you find this part confusing???). This PR rather clarifies that there may be two ways to reference the same artifact, examples:
-
vs.
<dependency> <groupId>org.project</groupId> <artifactId>reusable-test-support</artifactId> <version>1.0</version> <classifier>tests</classifier> </dependency><dependency> <groupId>org.project</groupId> <artifactId>reusable-test-support</artifactId> <version>1.0</version> <type>test-jar</type> </dependency> -
vs.
<dependency> <groupId>org.project</groupId> <artifactId>my-osgi-bundle</artifactId> <version>1.0</version> </dependency><dependency> <groupId>org.project</groupId> <artifactId>my-osgi-bundle</artifactId> <version>1.0</version> <type>bundle</type> <!-- defined by artifact handler in maven-bundle-plugin --> </dependency> -
vs.
<dependency> <groupId>org.project</groupId> <artifactId>my-content-package</artifactId> <version>1.0</version> <type>zip</type> </dependency><dependency> <groupId>org.project</groupId> <artifactId>my-content-package</artifactId> <version>1.0</version> <type>content-package</type> <!-- defined by artifact handler in filevault-package-maven-plugin --> </dependency>
Please be more concise with your criticism so that I am able to address it.
elharo
reviewed
Dec 10, 2024
| different extension and a classifier. The type often corresponds to the packaging used, though this is | ||
| also not always the case. Some examples are <<<jar>>>, <<<ejb-client>>> and <<<test-jar>>>: | ||
| see {{{/ref/current/maven-core/artifact-handlers.html}default artifact handlers}} for a list. New types can be | ||
| defined by plugins that set <<<extensions>>> to true, so this is not a complete list. | ||
|
|
||
| In case there is an artifact handler defined there are <two> different ways of referencing the same dependency: | ||
| By using the artifact's <extension> or by using the registered <type> value. The latter considers all attributes from the artifact handler, while the former |
|
|
||
| In case there is an artifact handler defined there are <two> different ways of referencing the same dependency: | ||
| By using the artifact's <extension> or by using the registered <type> value. The latter considers all attributes from the artifact handler, while the former | ||
| never adds the dependency to the classpath nor includes its dependencies. Further information in |
| different extension and a classifier. The type often corresponds to the packaging used, though this is | ||
| also not always the case. Some examples are <<<jar>>>, <<<ejb-client>>> and <<<test-jar>>>: | ||
| see {{{/ref/current/maven-core/artifact-handlers.html}default artifact handlers}} for a list. New types can be | ||
| defined by plugins that set <<<extensions>>> to true, so this is not a complete list. | ||
|
|
||
| In case there is an artifact handler defined there are <two> different ways of referencing the same dependency: |
There was a problem hiding this comment.
If an artifact handler is defined,
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
(with a related artifact handler)