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.

Sign up for GitHub

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

[MNG-8097] Outline the two different ways to reference a dependency #529

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

[MNG-8097] Outline the two different ways to reference a dependency #529

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
87229d3
[MNG-8097] Outline the two different ways to reference a dependency
kwin May 18, 2024
8bfb470
incorporate some feedback from PR
kwin Jun 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion content/apt/pom.apt.vm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,13 +271,20 @@ mvn install:install-file -Dfile=non-maven-proj.jar -DgroupId=some.group -Dartifa
you browse the Maven central repository, you will notice that the classifiers <<<sources>>> and <<<javadoc>>> are used
to deploy the project source code and API docs along with the packaged class files.

The classifier may also be derived from the <<type>> in case the related {{{/ref/current/maven-core/artifact-handlers.html} artifact handler}} defines one.

* <<type>>:\
Corresponds to the chosen dependency type. This defaults to <<<jar>>>. While it usually represents
the extension on the filename of the dependency, that is not always the case: a type can be mapped to a
the extension of the referenced artifact, that is not always the case: a type can be mapped to a
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:
Copy link
Member

@cstamas cstamas May 21, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Member Author

@kwin kwin May 28, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

  1. <dependency>
  <groupId>org.project</groupId>
  <artifactId>reusable-test-support</artifactId>
  <version>1.0</version>
  <classifier>tests</classifier>
</dependency>
    vs. 
    <dependency>
  <groupId>org.project</groupId>
  <artifactId>reusable-test-support</artifactId>
  <version>1.0</version>
  <type>test-jar</type>
</dependency>

  2. <dependency>
  <groupId>org.project</groupId>
  <artifactId>my-osgi-bundle</artifactId>
  <version>1.0</version>
</dependency>
    vs. 
    <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>


  3.  <dependency>
   <groupId>org.project</groupId>
   <artifactId>my-content-package</artifactId>
   <version>1.0</version>
   <type>zip</type>
 </dependency>
    vs. 
    <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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If an artifact handler is defined,

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sentence fragment

never adds the dependency to the classpath nor includes its dependencies. Further information in
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in --> can be found in

{{{/repositories/artifacts.html#but-where-do-i-set-artifact-extension}Maven Artifacts}}.

* <<scope>>:\
This element refers to the classpath of the task at hand (compiling and runtime, testing, etc.) as well as
Expand Down