Required Parameters

Name	Type	Since	Description
file	File	1.0-beta-4	File to be deployed.
repositoryId	String	1.0-beta-4	Server Id to map on the <id> under <server> section of settings.xml. In most cases, this parameter will be required for authentication. Default value is: remote-repository.
url	String	1.0-beta-4	URL where the artifact will be deployed. ie ( file:///C:/m2-repo or scp://host.com/path/to/repo )

Optional Parameters

Name	Type	Since	Description
artifactId	String	1.0-beta-4	ArtifactId of the artifact to be deployed. Retrieved from POM file if specified.
ascDirectory	File	1.0-beta-4	The directory where to store signature files.
classifier	String	1.0-beta-4	Add classifier to the artifact
classifiers	String	1.0-beta-4	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.
defaultKeyring	boolean	1.2	Whether to add the default keyrings from gpg's home directory to the list of used keyrings. Default value is: true.
description	String	1.0-beta-4	Description passed to a generated POM file (in case of generatePom=true).
executable	String	1.1	The path to the GnuPG executable to use for artifact signing. Defaults to either "gpg" or "gpg.exe" depending on the operating system.
files	String	1.0-beta-4	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.
generatePom	boolean	1.0-beta-4	Upload a POM for this artifact. Will generate a default POM if none is supplied with the pomFile argument. Default value is: true.
groupId	String	1.0-beta-4	GroupId of the artifact to be deployed. Retrieved from POM file if specified.
homedir	File	1.0	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.
javadoc	File	1.3	The bundled API docs for the artifact.
keyname	String	1.0-beta-4	The "name" of the key to sign with. Passed to gpg as --local-user.
packaging	String	1.0-beta-4	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.
passphrase	String	1.0-beta-4	The passphrase to use when signing.
pomFile	File	1.0-beta-4	Location of an existing POM file to be deployed alongside the main artifact, given by the ${file} parameter.
publicKeyring	String	1.2	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.
repositoryLayout	String	1.0-beta-4	The type of remote repository layout to deploy to. Try legacy for a Maven 1.x-style repository layout. Default value is: default.
retryFailedDeploymentCount	int	1.3	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. Default value is: 1.
secretKeyring	String	1.2	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.
sources	File	1.3	The bundled sources for the artifact.
types	String	1.0-beta-4	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.
uniqueVersion	boolean	1.0-beta-4	Whether to deploy snapshots with a unique version or not. Default value is: true.
updateReleaseInfo	boolean	1.3	Parameter used to update the metadata to make the artifact as release. Default value is: false.
useAgent	boolean	1.0-beta-4	Passes --use-agent or --no-use-agent to gpg. If using an agent, the passphrase is optional as the agent will provide it. For gpg2, specify true as --no-use-agent was removed in gpg2 and doesn't ask for a passphrase anymore. Default value is: false.
version	String	1.0-beta-4	Version of the artifact to be deployed. Retrieved from POM file if specified.

Parameter Details

artifactId:

• Type: java.lang.String
• Since: 1.0-beta-4
• Required: No
• Expression: ${artifactId}

---

ascDirectory:

• Type: java.io.File
• Since: 1.0-beta-4
• Required: No
• Expression: ${gpg.ascDirectory}

---

classifier:

• Type: java.lang.String
• Since: 1.0-beta-4
• Required: No
• Expression: ${classifier}

---

classifiers:

• Type: java.lang.String
• Since: 1.0-beta-4
• Required: No
• Expression: ${classifiers}

---

defaultKeyring:

• Type: boolean
• Since: 1.2
• Required: No
• Expression: ${gpg.defaultKeyring}
• Default: true

---

description:

• Type: java.lang.String
• Since: 1.0-beta-4
• Required: No
• Expression: ${generatePom.description}

---

executable:

• Type: java.lang.String
• Since: 1.1
• Required: No
• Expression: ${gpg.executable}

---

file:

• Type: java.io.File
• Since: 1.0-beta-4
• Required: Yes
• Expression: ${file}

---

files:

• Type: java.lang.String
• Since: 1.0-beta-4
• Required: No
• Expression: ${files}

---

generatePom:

• Type: boolean
• Since: 1.0-beta-4
• Required: No
• Expression: ${generatePom}
• Default: true

---

groupId:

• Type: java.lang.String
• Since: 1.0-beta-4
• Required: No
• Expression: ${groupId}

---

homedir:

• Type: java.io.File
• Since: 1.0
• Required: No
• Expression: ${gpg.homedir}

---

javadoc:

• Type: java.io.File
• Since: 1.3
• Required: No
• Expression: ${javadoc}

---

keyname:

• Type: java.lang.String
• Since: 1.0-beta-4
• Required: No
• Expression: ${gpg.keyname}

---

packaging:

• Type: java.lang.String
• Since: 1.0-beta-4
• Required: No
• Expression: ${packaging}

---

passphrase:

• Type: java.lang.String
• Since: 1.0-beta-4
• Required: No
• Expression: ${gpg.passphrase}

---

pomFile:

• Type: java.io.File
• Since: 1.0-beta-4
• Required: No
• Expression: ${pomFile}

---

publicKeyring:

• Type: java.lang.String
• Since: 1.2
• Required: No
• Expression: ${gpg.publicKeyring}

---

repositoryId:

• Type: java.lang.String
• Since: 1.0-beta-4
• Required: Yes
• Expression: ${repositoryId}
• Default: remote-repository

---

repositoryLayout:

• Type: java.lang.String
• Since: 1.0-beta-4
• Required: No
• Expression: ${repositoryLayout}
• Default: default

---

retryFailedDeploymentCount:

• Type: int
• Since: 1.3
• Required: No
• Expression: ${retryFailedDeploymentCount}
• Default: 1

---

secretKeyring:

• Type: java.lang.String
• Since: 1.2
• Required: No
• Expression: ${gpg.secretKeyring}

---

sources:

• Type: java.io.File
• Since: 1.3
• Required: No
• Expression: ${sources}

---

types:

• Type: java.lang.String
• Since: 1.0-beta-4
• Required: No
• Expression: ${types}

---

uniqueVersion:

• Type: boolean
• Since: 1.0-beta-4
• Required: No
• Expression: ${uniqueVersion}
• Default: true

---

updateReleaseInfo:

• Type: boolean
• Since: 1.3
• Required: No
• Expression: ${updateReleaseInfo}
• Default: false

---

url:

• Type: java.lang.String
• Since: 1.0-beta-4
• Required: Yes
• Expression: ${url}

---

useAgent:

• Type: boolean
• Since: 1.0-beta-4
• Required: No
• Expression: ${gpg.useagent}
• Default: false

---

version:

• Type: java.lang.String
• Since: 1.0-beta-4
• Required: No
• Expression: ${version}