This is an automated email from the ASF dual-hosted git repository.
hboutemy pushed a commit to branch deploy
in repository https://gitbox.apache.org/repos/asf/maven-studies.git
The following commit(s) were added to refs/heads/deploy by this push:
new 46180cc5b describe more precisely the behaviours
46180cc5b is described below
commit 46180cc5bf64f3cf45be690bc3f25e38b50b441a
Author: Hervé Boutemy <[email protected]>
AuthorDate: Thu Jul 17 03:29:20 2025 +0200
describe more precisely the behaviours
---
README.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++---------
pom.xml | 55 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
2 files changed, 101 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md
index d4deee7b5..ebb6a2388 100644
--- a/README.md
+++ b/README.md
@@ -1,26 +1,46 @@
+# deployment solutions study
-# init content
+Study to better understand
[maven-deploy-plugin](https://maven.apache.org/plugins/maven-deploy-plugin/),
how it deploys artifacts traditionnally to a [Maven
repository](https://maven.apache.org/repository/layout.html),
+and how the new Maven Central Portal publication changes the approach.
+Test project is a multi-module build created though an archetype:
https://maven.apache.org/archetypes/maven-archetype-j2ee-simple/
mvn archetype:generate -DarchetypeGroupId=org.apache.maven.archetypes
-DarchetypeArtifactId=maven-archetype-j2ee-simple -DarchetypeVersion=1.5
-# deploy to local directory `target/deploy`
+And few additions to [`pom.xml`](pom.xml) for some of the tests.
+
+## basic test: deploy to local directory `target/deploy`
+
+Instead of classical deployment to an HTTP(S) server (PUT), or scp or any
other file-oriented server, we can easily test `maven-deploy-plugin:deploy` to
deploy to a local directory using `altDeploymentRepository` parameter with a
`file:` target url:
mvn clean deploy -DaltDeploymentRepository=local::file:target/deploy
- # intentionally no GPG signature and no javadoc
-# deploy atEnd
+resulting files and directory tree is available in `target/deploy`, showing
many individual files:
+
+ tree target/deploy
+
+Intentionally, we did not add sources, GPG signature nor javadoc, but a
`central-prerequisites` profile is provided to add them to the structure.
+
+ mvn clean deploy -DaltDeploymentRepository=local::file:target/deploy
-Pcentral-prerequisites
+
+## install/deploy "at end"
+
+With install/deploy [at
end](https://maven.apache.org/plugins/maven-deploy-plugin/deploy-mojo.html#deployAtEnd),
instead of deploying the files for each module when the module is built,
install/deploy is deferred on each module, to the last one that does every
previous modules in a single run:
mvn clean deploy -DaltDeploymentRepository=local::file:target/deploy
-DinstallAtEnd -DdeployAtEnd
-# manual upload to Maven Central Portal
+## manual upload to Maven Central Portal
+
+Based on previous deploy to `target/deploy` local directory, it's easy to
create a deployment bundle:
tar cvf deploy-bundle.tar -C target/deploy org
-then deploy with UI
+then upload with Maven Central Portal ["Publish
Component"](https://central.sonatype.com/publishing) UI (publication is
expected to fail because you don't have permissions on the groupId, but you can
test and see the behaviour).
+
+Upload can also be done using `curl` to the
[`/api/v1/publisher/upload`](https://central.sonatype.com/api-doc) API
-# deploy with Sonatype Maven plugin
+## deploy with Sonatype Maven plugin
https://central.sonatype.org/publish/publish-portal-maven/
@@ -34,8 +54,26 @@ with a fake server defined in `~/.m2/settings.xml`
<password>fake</password>
</server>
-# deploy with njord extension to Maven Resolver
+Running with this plugin completely removes the `maven-deploy-plugin` from the
build execution (as if it was not inherited from parent POM...), replacing with
`central-publishing:publish`.
+
+Individual files are staged to `target/central-staging`, before creating a
publication bundle as `target/central-publishing/central-bundle.zip` and
uploading it:
+
+ tree target/central-*
+
+TODO: see also SNAPSHOT case
+
+## deploy with njord extension to Maven Resolver
https://maveniverse.eu/docs/njord/
- mvn clean deploy -Pnjord -DaltDeploymentRepository=id::njord:
+ mvn clean deploy -DaltDeploymentRepository=id::njord:
+
+With njord, `maven-deploy-plugin` stages the content to `njord:` url, which in
fact stores content in `~/.njord/deploy-<counter>`:
+
+ tree ~/.njord/deploy-*
+
+And at Maven build end of execution (through [a
MavenLifecycleParticipant](https://github.com/maveniverse/njord/blob/main/extension3/src/main/java/eu/maveniverse/maven/njord/extension3/NjordSessionLifecycleParticipant.java)),
after `BUILD SUCCESS`, the staged content is eventually uploaded to Maven
Central Portal upload API, or can be manipulated with [`njord-maven-plugin`
provided
goals](https://maveniverse.eu/docs/njord/plugin-documentation/plugin-info.html):
+
+ mvn -Pnjord njord:list
+
+TODO: test also everything with Maven 4
diff --git a/pom.xml b/pom.xml
index 1d080c1dc..2999e8060 100644
--- a/pom.xml
+++ b/pom.xml
@@ -51,8 +51,53 @@
</profile>
<profile>
- <id>njord</id>
+ <id>central-prerequisites</id>
<build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-source-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>attach-sources</id>
+ <goals>
+ <goal>jar-no-fork</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>attach-javadocs</id>
+ <goals>
+ <goal>jar</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-gpg-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>sign-artifacts</id>
+ <phase>verify</phase>
+ <goals>
+ <goal>sign</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+ </profile>
+
+ <profile>
+ <id>njord</id>
+ <build>
<pluginManagement>
<plugins>
<plugin>
@@ -148,6 +193,14 @@
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.11.2</version>
</plugin>
+ <plugin>
+ <artifactId>maven-source-plugin</artifactId>
+ <version>3.3.1</version>
+ </plugin>
+ <plugin>
+ <artifactId>maven-gpg-plugin</artifactId>
+ <version>3.2.8</version>
+ </plugin>
</plugins>
</pluginManagement>
</build>
