This is an automated email from the ASF dual-hosted git repository. sjaranowski pushed a commit to branch MASSEMBLY-974-doc in repository https://gitbox.apache.org/repos/asf/maven-assembly-plugin.git
commit 3dfb66dd389372a69b756340787ba08e9f04c80d Author: Slawomir Jaranowski <[email protected]> AuthorDate: Thu Apr 20 14:35:46 2023 +0200 [MASSEMBLY-974] Drop deprecated repository element from documentation Code was removed in 6c7b43c4e5a96bef884131e87b00942e5cd901dc We should update documentation according to change. --- src/site/apt/advanced-descriptor-topics.apt.vm | 2 +- src/site/apt/examples/index.apt | 2 - src/site/apt/examples/single/index.apt | 2 - .../apt/examples/single/using-repositories.apt.vm | 131 --------------------- src/site/site.xml | 1 - 5 files changed, 1 insertion(+), 137 deletions(-) diff --git a/src/site/apt/advanced-descriptor-topics.apt.vm b/src/site/apt/advanced-descriptor-topics.apt.vm index 9af204e0..8eb25a25 100644 --- a/src/site/apt/advanced-descriptor-topics.apt.vm +++ b/src/site/apt/advanced-descriptor-topics.apt.vm @@ -41,7 +41,7 @@ Advanced Assembly-Descriptor Topics add the file to the archive "wins". The filtering is done solely based on name inside the archive, so the same source file can be added under different output names. The order of the phases is as follows: - 1) FileItem 2) FileSets 3) ModuleSet 4) DepenedencySet and 5) Repository elements. + 1) FileItem 2) FileSets 3) ModuleSet 4) DepenedencySet. Elements of the same type will be processed in the order they appear in the descriptors. If you need to "overwrite" a file included by a previous set, diff --git a/src/site/apt/examples/index.apt b/src/site/apt/examples/index.apt index a60998c1..39a6d28a 100644 --- a/src/site/apt/examples/index.apt +++ b/src/site/apt/examples/index.apt @@ -41,8 +41,6 @@ Examples * {{{./single/using-components.html}Using Component Descriptors}} - * {{{./single/using-repositories.html}Using Repositories}} - * {{{./single/using-container-descriptor-handlers.html}Using Container Descriptor Handlers}} [] diff --git a/src/site/apt/examples/single/index.apt b/src/site/apt/examples/single/index.apt index eb9366d1..2e82d6cf 100644 --- a/src/site/apt/examples/single/index.apt +++ b/src/site/apt/examples/single/index.apt @@ -39,6 +39,4 @@ Single Project Examples * {{{./using-components.html}Using Component Descriptors}} - * {{{./using-repositories.html}Using Repositories}} - * {{{./using-container-descriptor-handlers.html}Using Container Descriptor Handlers}} diff --git a/src/site/apt/examples/single/using-repositories.apt.vm b/src/site/apt/examples/single/using-repositories.apt.vm deleted file mode 100644 index 5302a2b1..00000000 --- a/src/site/apt/examples/single/using-repositories.apt.vm +++ /dev/null @@ -1,131 +0,0 @@ - ------ - Using Repositories - ------ - Edwin Punzalan - ------ - 2006-07-26 - ------ - -~~ 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. - -~~ NOTE: For help with the syntax of this file, see: -~~ https://maven.apache.org/doxia/references/apt-format.html - -Using Repositories - -* Introduction - - The Assembly Plugin allows the inclusion of needed artifacts from your local - repository to the generated archive. They are copied into the assembly in a - directory similar to what's in your remote repository, complete with metadata - and the checksums. - - This example demonstrates the creation of repository artifacts in an assembly - so that the archive can easily be used to update an internal repository with - the artifacts used by your project. - -* The Assembly Descriptor - - A functional repository archive for your project can be created with: - -+----- -<assembly xmlns="http://maven.apache.org/ASSEMBLY/${mdoVersion}"; - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; - xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/${mdoVersion} http://maven.apache.org/xsd/assembly-${mdoVersion}.xsd";> - <id>repository</id> - <formats> - <format>jar</format> - </formats> - <repositories> - <repository> - <includeMetadata>true</includeMetadata> - <outputDirectory>maven2</outputDirectory> - </repository> - </repositories> -</assembly> -+----- - - The above descriptor tells the Assembly Plugin to create a repository-like - directory structure inside the <<<maven2>>> directory from within the - generated archive. Setting <<<includeMetadata>>> to <<<true>>> will make the - plugin to also copy metadata information into the generated archive. - -* The POM - - The pom.xml for your project is very similar to how you configure the Assembly - Plugin for other distribution types. - -+----- -<project> - [...] - <build> - [...] - <plugins> - [...] - <plugin> - <artifactId>maven-assembly-plugin</artifactId> - <version>${project.version}</version> - <configuration> - <descriptors> - <descriptor>src/assembly/repository.xml</descriptor> - </descriptors> - </configuration> - </plugin> - [...] -</project> -+----- - -* Generating The Assembly Archive - - The assembly archive is then created using: - -+----- -mvn clean assembly:single -+----- - - The generated archive can be extracted to an internal repository so users of - your project can download the dependencies from it. - -* Examining the Output - - When the Maven execution completes, the archive contents should be similar to: - ------- -target/artifactId-version-repository.jar -`-- maven2 - |-- groupId - | |-- maven-metadata.xml - | |-- maven-metadata.xml.md5 - | |-- maven-metadata.xml.sha1 - | `-- artifactId - | |-- maven-metadata.xml - | |-- maven-metadata.xml.md5 - | |-- maven-metadata.xml.sha1 - | `-- version - | |-- artifactId-version.jar - | |-- artifactId-version.jar.md5 - | |-- artifactId-version.jar.sha1 - | |-- artifactId-version.pom - | |-- artifactId-version.pom.md5 - | |-- artifactId-version.pom.sha1 - | |-- maven-metadata.xml - | |-- maven-metadata.xml.md5 - | `-- maven-metadata.xml.sha1 - `-- groupId2 - `-- [...] ------- diff --git a/src/site/site.xml b/src/site/site.xml index fa95d739..4f304a55 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -52,7 +52,6 @@ under the License. <item name="Filtering Some Distribution Files" href="./examples/single/filtering-some-distribution-files.html"/> <item name="Including/Excluding Artifacts" href="./examples/single/including-and-excluding-artifacts.html"/> <item name="Using Component Descriptors" href="./examples/single/using-components.html"/> - <item name="Using Repositories" href="./examples/single/using-repositories.html"/> <item name="Using Container Descriptor Handlers" href="./examples/single/using-container-descriptor-handlers.html"/> </item> <item name="Multimodule Projects" collapse="false" href="./examples/multimodule/index.html">
