BC Signer only: The comma separate list of Unix Domain Socket paths, to use to communicate with GnuPG agent. If relative, they are resolved against user home directory.

ArtifactId of the artifact to be deployed. Retrieved from POM file if specified.

The directory where to store signature files.

Switch to improve plugin enforcement of "best practices". If set to false, plugin retains all the backward compatibility regarding getting secrets (but will warn). If set to true, plugin will fail if any "bad practices" regarding sensitive data handling are detected. By default, plugin remains backward compatible (this flag is false). Somewhere in the future, when this parameter enabling transitioning from older plugin versions is removed, the logic using this flag will be modified like it is set to true. It is warmly advised to configure this parameter to true and migrate project and user environment regarding how sensitive information is stored.

Add classifier to the artifact

A comma separated list of classifiers for each of the extra side artifacts to deploy. If there is a mis-match in the number of entries in files or types, then an error will be raised.

GPG Signer only: Whether to add the default keyrings from gpg's home directory to the list of used keyrings.

Description passed to a generated POM file (in case of generatePom=true).

GPG Signer only: The path to the GnuPG executable to use for artifact signing. Defaults to either "gpg" or "gpg.exe" depending on the operating system.

File to be deployed.

A comma separated list of files for each of the extra side artifacts to deploy. If there is a mis-match in the number of entries in types or classifiers, then an error will be raised.

Upload a POM for this artifact. Will generate a default POM if none is supplied with the pomFile argument.

GPG Signer only: Sets the arguments to be passed to gpg. Example:

<gpgArguments>
  <arg>--no-random-seed-file</arg>
  <arg>--no-permission-warning</arg>
</gpgArguments>

GroupId of the artifact to be deployed. Retrieved from POM file if specified.

GPG Signer only: The directory from which gpg will load keyrings. If not specified, gpg will use the value configured for its installation, e.g. ~/.gnupg or %APPDATA%/gnupg.

The bundled API docs for the artifact.

BC Signer only: The env variable name where the GnuPG key is set. To use BC Signer you must provide GnuPG key, as it does not use GnuPG home directory to extract/find the key (while it does use GnuPG Agent to ask for password in interactive mode). The key should be in TSK format and may be passphrase protected.

BC Signer only: The path of the exported key in TSK format, and may be passphrase protected. If relative, the file is resolved against user home directory.

Note: it is not recommended to have sensitive files checked into SCM repository. Key file should reside on developer workstation, outside of SCM tracked repository. For CI-like use cases you should set the key material as env variable instead.

BC Signer only: The fingerprint of the key to use for signing. If not given, first key in keyring will be used.

BC Signer only: The env variable name where the GnuPG key fingerprint is set, if the provided keyring contains multiple keys.

GPG Signer only: The "name" of the key to sign with. Passed to gpg as --local-user.

GPG Signer only: The lock mode to use when invoking gpg. By default no lock mode will be specified. Valid values are once, multiple and never. The lock mode gets translated into the corresponding --lock-___ command line argument. Improper usage of this option may lead to data and key corruption.
See also: the --lock-options

Type of the artifact to be deployed. Retrieved from POM file if specified. Defaults to file extension if not specified via command line or POM.

Deprecated. Do not use this configuration, it may leak sensitive information. Rely on gpg-agent or env variables instead.

The passphrase to use when signing. If not given, look up the value under Maven settings using server id at 'passphraseServerKey' configuration. Do not use this parameter, it leaks sensitive data. Passphrase should be provided only via gpg-agent or via env variable. If parameter bestPractices set to true, plugin fails when this parameter is configured.

The env variable name where the GnuPG passphrase is set. This is the recommended way to pass passphrase for signing in batch mode execution of Maven.

Deprecated. Do not use this configuration, it may leak sensitive information. Rely on gpg-agent or env variables instead.

Server id to lookup the passphrase under Maven settings. Do not use this parameter, it leaks sensitive data. Passphrase should be provided only via gpg-agent or via env variable. If parameter bestPractices set to true, plugin fails when this parameter is configured.

Location of an existing POM file to be deployed alongside the main artifact, given by the ${file} parameter.

Deprecated. Obsolete option since GnuPG 2.1 version.

GPG Signer only: The path to a public keyring to add to the list of keyrings. By default, only the pubring.gpg from gpg's home directory is considered. Use this option (and defaultKeyring if required) to use a different public key. Note: Relative paths are resolved against gpg's home directory, not the project base directory.

NOTE: As of gpg 2.1 this is an obsolete option and ignored. All public keys are stored in the ‘pubring.kbx’ file below the GnuPG home directory.

Server Id to map on the <id> under <server> section of settings.xml. In most cases, this parameter will be required for authentication.

The type of remote repository layout to deploy to. Try legacy for a Maven 1.x-style repository layout.

Parameter used to control how many times a failed deployment will be retried before giving up and failing. If a value outside the range 1-10 is specified it will be pulled to the nearest value within the range 1-10.

Deprecated. Obsolete option since GnuPG 2.1 version.

GPG Signer only: The path to a secret keyring to add to the list of keyrings. By default, only the secring.gpg from gpg's home directory is considered. Use this option (in combination with publicKeyring and defaultKeyring if required) to use a different secret key. Note: Relative paths are resolved against gpg's home directory, not the project base directory.

NOTE: As of gpg 2.1 this is an obsolete option and ignored. All secret keys are stored in the ‘private-keys-v1.d’ directory below the GnuPG home directory.

The name of the Signer implementation to use. Accepted values are "gpg" (the default, uses GnuPG executable) and "bc" (uses Bouncy Castle pure Java signer).

Skip doing the gpg signing.

The bundled sources for the artifact.

A comma separated list of types for each of the extra side artifacts to deploy. If there is a mis-match in the number of entries in files or classifiers, then an error will be raised.

URL where the artifact will be deployed.
ie ( file:///C:/m2-repo or https://host.com/path/to/repo )

All signers: whether gpg-agent is allowed to be used or not. If enabled, passphrase is optional, as agent may provide it. Have to be noted, that in "batch" mode, gpg-agent will be prevented to pop up pinentry dialogue, hence best is to "prime" the agent caches beforehand.

GPG Signer: Passes --use-agent or --no-use-agent option to gpg if it is version 2.1 or older. Otherwise, will use an agent. In non-interactive mode gpg options are appended with --pinentry-mode error, preventing gpg agent to pop up pinentry dialogue. Agent will be able to hand over only cached passwords.

BC Signer: Allows signer to communicate with gpg agent. In non-interactive mode it uses --no-ask option with the GET_PASSPHRASE function. Agent will be able to hand over only cached passwords.

Version of the artifact to be deployed. Retrieved from POM file if specified.