(doc) Add FAQ entry for using custom deploy plugin#1388
(doc) Add FAQ entry for using custom deploy plugin#1388kwin merged 1 commit intoapache:masterfrom Marcono1234:custom-deploy-plugin
Conversation
| However, you can set the <a href="./prepare-mojo.html#autoVersionSubmodules"><code>autoVersionSubmodules</code> parameter</a> | ||
| to <code>true</code> to automatically use the parent version.</p> |
There was a problem hiding this comment.
Note: This is not directly related to the new FAQ entry, but since I edited the FAQ anyway I took the chance to change this too.
(I hope I understood the question correctly though.)
| This allows you for example to use the <code>central-publishing-maven-plugin</code> when | ||
| <a href="https://central.sonatype.org/publish/publish-portal-maven/">deploying to Maven Central</a>.</p> | ||
| <p>However, it might be necessary to configure the Maven Deploy Plugin to skip execution because the | ||
| plugin is <a href="https://maven.apache.org/ref/current/maven-core/default-bindings.html#Plugin_bindings_for_jar_packaging"> |
There was a problem hiding this comment.
I used /current/ here in the URL to use the latest Maven version. But this risks that the link could break in the future. Please let me know if you prefer to hardcode a specific recent Maven version here instead.
| <a href="https://central.sonatype.org/publish/publish-portal-maven/">deploying to Maven Central</a>.</p> | ||
| <p>However, it might be necessary to configure the Maven Deploy Plugin to skip execution because the | ||
| plugin is <a href="https://maven.apache.org/ref/current/maven-core/default-bindings.html#Plugin_bindings_for_jar_packaging"> | ||
| automatically configured by default</a> (note that some custom deploy plugins automatically disable |
There was a problem hiding this comment.
Added this "note that some custom deploy plugins automatically disable the Maven Deploy Plugin" because it seems for example central-publishing-maven-plugin automatically disables the Deploy Plugin, see plugin source code (unofficial mirror).
This might confuse users when the Deploy Plugin is not executed without the user having explicitly disabled it.
| <plugin> | ||
| <groupId>org.apache.maven.plugins</groupId> | ||
| <artifactId>maven-deploy-plugin</artifactId> | ||
| <version>...</version> |
There was a problem hiding this comment.
Is using ... as version fine here, or should I instead use the version number of a recent Deploy Plugin release?
|
Thanks for the review! Is there something else I should do, or does someone else have to review as well before this can be merged? |
|
@kwin Please assign appropriate label to PR according to the type of change. |
2 participants
Related to google/gson#2892, it is currently not directly clear how Maven Release Plugin can be used with a custom deploy plugin (such as
central-publishing-maven-pluginwhen publishing to Maven Central) and whether the Maven Release Plugin is entagled with the Maven Deploy Plugin.This pull request adds a new FAQ entry which tries to clarify this.
Warning
The changes here are based on my understanding of how the Maven Release Plugin works, but I might be wrong.
Please let me know if anything of this is incorrect.
Following this checklist to help us incorporate your
contribution quickly and easily:
Note that commits might be squashed by a maintainer on merge.
This may not always be possible but is a best-practice.
mvn verifyto make sure basic checks pass.A more thorough check will be performed on your pull request automatically.
mvn -Prun-its verify).If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.
To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.