gpg:sign

Sign project artifact, the POM, and attached artifacts with GnuPG for deployment.

Mojo Attributes:

  • Requires a Maven 2.0 project to execute.
  • Automatically executes within the lifecycle phase: verify

Required Parameters

Name Type Description
skip boolean Skip doing the gpg signing Default value is false.
useAgent boolean Passes --use-agent or --no-use-agent to gpg. If using an agent, the password is optional as the agent will provide it. Default value is false.

Optional Parameters

Name Type Description
artifactHandlerManager ArtifactHandlerManager Maven ArtifactHandlerManager
excludes String[] A list of files to exclude from being signed. Can contain ant-style wildcards and double wildcards. The default includes are **/*.md5 **/*.sha1 **/*.asc
keyname String The "name" of the key to sign with. Passed to gpg as --local-user.
outputDirectory File The directory where to store signature files.
passphrase String The passphrase to use when signing.
projectHelper MavenProjectHelper Maven ProjectHelper

Parameter Details

artifactHandlerManager

Maven ArtifactHandlerManager

  • Type: org.apache.maven.artifact.handler.manager.ArtifactHandlerManager
  • Required: No

excludes A list of files to exclude from being signed. Can contain ant-style wildcards and double wildcards. The default includes are **/*.md5 **/*.sha1 **/*.asc
  • Type: java.lang.String[]
  • Since: 1.0-alpha-4
  • Required: No

keyname The "name" of the key to sign with. Passed to gpg as --local-user.
  • Type: java.lang.String
  • Required: No
  • Expression: ${gpg.keyname}

outputDirectory The directory where to store signature files.
  • Type: java.io.File
  • Since: 1.0-alpha-4
  • Required: No
  • Expression: ${project.build.directory}/gpg

passphrase The passphrase to use when signing.
  • Type: java.lang.String
  • Required: No
  • Expression: ${gpg.passphrase}

projectHelper Maven ProjectHelper
  • Type: org.apache.maven.project.MavenProjectHelper
  • Required: No

skip Skip doing the gpg signing
  • Type: boolean
  • Required: Yes
  • Expression: ${gpg.skip}
  • Default: false

useAgent Passes --use-agent or --no-use-agent to gpg. If using an agent, the password is optional as the agent will provide it.
  • Type: boolean
  • Required: Yes
  • Expression: ${gpg.useagent}
  • Default: false