This is an automated email from the ASF dual-hosted git repository.
hboutemy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-site.git
The following commit(s) were added to refs/heads/master by this push:
new ee7f658 Maven 2 layout documentation init
ee7f658 is described below
commit ee7f658878090d2a1641f1ce1a20c00f43364ca0
Author: Hervé Boutemy <[email protected]>
AuthorDate: Tue Jan 18 22:40:06 2022 +0100
Maven 2 layout documentation init
---
content/markdown/repository/layout.md | 63 +++++++++++++++++++++++++++++++++++
content/site.xml | 1 +
2 files changed, 64 insertions(+)
diff --git a/content/markdown/repository/layout.md
b/content/markdown/repository/layout.md
new file mode 100644
index 0000000..45df3f5
--- /dev/null
+++ b/content/markdown/repository/layout.md
@@ -0,0 +1,63 @@
+## Maven2 Repository Layout
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+Maven2 repository layout format is the default layout used since Maven 2,
superceding old Maven 1 layout:
+
+```
+Repository root
+`-- <groupId as directory>
+ |-- maven-medatada.xml
+ |-- .xml.<checksums>
+ `-- <artifactId>
+ |-- maven-medatada.xml
+ |-- .xml.<checksums>
+ `-- <version>
+ |-- <artifactId>-<version>.pom
+ |-- .pom.asc
+ |-- .pom.<checksums>
+ |-- <artifactId>-<version>.<extension>
+ |-- .asc
+ |-- .<checksums>
+ |-- <artifactId>-<version>-<classifier>.<extension>
+ |-- .<extension>.asc
+ `-- .<extension>.<checksums>
+```
+
+where:
+
+- `<groupId as directory>` is the groupId with `.` replaced by `/`, for
example `org/apache/maven`,
+- `<artifactId>` is the artifactId,
+- `<version>` is the version, with some additional possibilities on a
SNAPSHOT, see SNAPSHOT paragraph,
+- `<extension>` is the file extension, for example `zip` or `tar.gz`,
+- `<classifier>` is the artifact classifier (when available),
+- `<checksums>` is a list of checksums algorithms, `md5` and `sha1` by default.
+
+`maven-metadata.xml` file format is defined in [Maven Repository Metadata
Model](/ref/current/maven-repository-metadata/).
+
+`.asc` file is optional (may be required in some repositories, like Central
Repository) and is a PGP detached signature file.
+
+## SNAPSHOT
+
+In case of a SNAPSHOT version, version directory uses base version, i.e.
version ending in `-SNAPSHOT`, for example `3.8.4-SNAPSHOT`.
+
+For artifact files, there are 2 options available:
+
+1. unique SNAPSHOT artifacts, using the same base version,
+2. multiple SNAPSHOT artifacts for one base version, each deployment will have
an effective version where `SNAPSHOT` is replaced with
`YYYYMMDD.HHMMSS-<counter>`.
diff --git a/content/site.xml b/content/site.xml
index 44de6e1..0b8ebfe 100644
--- a/content/site.xml
+++ b/content/site.xml
@@ -162,6 +162,7 @@ under the License.
<item name="Guide to Uploading Artifacts"
href="/repository/guide-central-repository-upload.html" />
<item name="Fixing Metadata" href="/repository/central-metadata.html"
/>
<item name="Central Index" href="/repository/central-index.html" />
+ <item name="Repository Layout" href="/repository/layout.html" />
</item>
<item name="Maven Developer Centre" href="/developers/index.html"
collapse="true">
<item name="Guide to Helping with Maven"
href="/guides/development/guide-helping.html" />
