(maven-apache-parent) branch master updated: [MPOM-481] Improve description of maven-gpg-plugin settings

[sj...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

sjaranowski pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-apache-parent.git


The following commit(s) were added to refs/heads/master by this push:
     new 7f4a9a9  [MPOM-481] Improve description of maven-gpg-plugin settings
7f4a9a9 is described below

commit 7f4a9a939ea33e29eeed83d6a26ca8e1b52fcb3a
Author: Slawomir Jaranowski <s....@gmail.com>
AuthorDate: Fri Apr 12 11:04:17 2024 +0200

    [MPOM-481] Improve description of maven-gpg-plugin settings
---
 src/site-docs/apt/index.apt.vm | 25 ++++++++++++++++++-------
 1 file changed, 18 insertions(+), 7 deletions(-)

diff --git a/src/site-docs/apt/index.apt.vm b/src/site-docs/apt/index.apt.vm
index 5576222..76dfb44 100644
--- a/src/site-docs/apt/index.apt.vm
+++ b/src/site-docs/apt/index.apt.vm
@@ -124,7 +124,8 @@ The <<<apache-release>>> Profile
 
    The profile includes the following plugins:
 
- * maven-assembly-plugin:
+ * maven-assembly-plugin
+
     {{{/apache-resource-bundles/source-release/}org.apache.apache.resources:apache-source-release-assembly-descriptor:$context.get("version.apache-resource-bundles")}}
     is added as dependency, and an execution is configured with <<<source-release-assembly>>> id.\
     The plugin is configured to take a <<<descriptorRef>>> name from the
@@ -134,15 +135,25 @@ The <<<apache-release>>> Profile
     If you want to avoid this default assembly execution to provide your own mechanism to produce the source release archive,
     you can disable the execution by configuring <<<skipAssembly>>> parameter for this <<<source-release-assembly>>> execution id
 
- * maven-source-plugin: configured to build and attach a source jar.
+ * maven-source-plugin
+
+   Configured to build and attach a source jar.
+
+ * maven-javadoc-plugin
+
+   Configured to build and attach a javadoc jar.
+
+ * maven-gpg-plugin
+
+   Configured to sign everything.
 
- * maven-javadoc-plugin: configured to build and attach a javadoc jar.
+   On developer workstations it expects GnuPG agent to be available to get passphrases,
+   while on fully unattended (CI-like) workflows the use of <<<MAVEN_GPG_PASSPHRASE>>> environment variable use is recommended.
 
- * maven-gpg-plugin: configured to sign everything. It expects to find
-    a passphrase in <<<$\{gpg.passphrase\}>>>, presumably in your <<<settings.xml>>>.
+ * checksum-maven-plugin
 
- * checksum-maven-plugin: configured to create a checksum file(s) for source release as
-    required by {{{http://www.apache.org/dev/release-distribution#sigs-and-sums}Apache release distribution policy}}.
+   Configured to create a checksum file(s) for source release as
+   required by {{{http://www.apache.org/dev/release-distribution#sigs-and-sums}Apache release distribution policy}}.
 
  []