michael-o commented on a change in pull request #654:
URL: https://github.com/apache/maven/pull/654#discussion_r786274967
##########
File path: maven-repository-metadata/src/site/apt/index.apt
##########
@@ -27,26 +27,32 @@ Maven Repository Metadata Model
This is strictly the model for Maven Repository Metadata, so really just
plain objects.
- Maven Repository Metadata is available in directories representing:
-
- [[1]] an un-versioned artifact: it gives informations about available
versions of the artifact,
+ The metadata file name is:
- [[2]] a snapshot artifact: it gives precise information on the snapshot,
+ * <<<maven-metadata.xml>>> in a remote repository,
- [[3]] a group containing Maven plugins artifacts: it gives informations on
plugins available in this group.
+ * <<<maven-metadata-\<repo-id>.xml>>> in a local repository, for metadata
from a repository with <<<repo-id>>> identifier.
[]
- The metadata file name is:
+ Depending on what the directory represents ("groupId", "groupId/artifactId"
or "groupId/artifactId/version"),
+ the Maven Repository Metadata file contains 3 different sets of metadata:
- * <<<maven-metadata.xml>>> in a remote repository,
+ [[1]] in a "groupId" directory: a "groupId" directory may contain Maven
plugins artifacts, which are described in metadata's <<<plugins>>> element,
- * <<<maven-metadata-\<repo-id>.xml>>> in a local repository, for metadata
from a repository with <<<repo-id>>> identifier.
+ [[2]] in a "groupId/artifactId" directory: metadata describes <<<groupId>>>,
<<<artifactId>>> and <<<versioning>>> element that
+ gives data about available versions (<<<latest>>>, <<<release>>>,
<<<versions>>> list and <<<lastUpdated>>>),
+
+ [[3]] in a "groupId/artifactId/version" snapshot artifact directory: metadata
describes <<<groupId>>>, <<<artifactId>>>, <<<version>>> (base version, ie
ending in <<<-SNAPSHOT>>>) and
+ <<<versioning>>> element that gives data about snaphot (<<<snapshot>>>,
<<<lastUpdated>>> and <<<snapshotVersions>>> list). Notice that a
+ release artifact directory is not expected to provide metadata.
[]
The following are generated from this model:
- * {{{./apidocs/index.html}Java sources}} with Reader and Writers for the
Xpp3 XML parser, to read and write <<<maven-metadata(-*).xml>>> files
+ * {{{./apidocs/index.html}Java sources}} with Reader and Writers for the
Xpp3 XML parser, to read and write <<<maven-metadata(-*).xml>>> files,
- * A {{{./repository-metadata.html}Descriptor Reference}}
+ * a {{{./repository-metadata.html}Descriptor Reference}}.
+
+ Notice: data about plugins in a directory representing a groupId is
deprecated and will be removed in a future Maven version (perhaps 4)
Review comment:
Maybe you should just mention that.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscr...@maven.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
