Fork me on GitHub
Built by Maven

sign:sign

Full name:

org.simplify4u.plugins:sign-maven-plugin:1.1.0:sign

Description:

Creates Open PGP / GPG signatures for all of the project's artifacts.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Since version: 0.1.0.
  • Binds by default to the lifecycle phase: verify.

Optional Parameters

Name Type Since Description
<excludes> List<String> 1.0.0 A list of files to exclude from being signed. Can contain Ant-style wildcards and double wildcards.
Default: **/*.md5,**/*.sha1,**/*.sha256,**/*.sha512,**/*.asc
<keyFile> File 0.1.0

File with private key used for signing.

This value can be delivered by environment variable SIGN_KEY. Environment variable must contain private key content - not file path for key.

If keyFile path start with ~/ then ~/ will be replace by user home directory - java user.home property

Key can by created and exported by:

     gpg --armor --export-secret-keys


Default: ${user.home}/.m2/sign-key.asc
User Property: sign.keyFile
<keyId> String 0.1.0

keyId used for signing. If not provided first key from keyFile will be taken.

This value can be delivered by environment variable SIGN_KEY_ID.


User Property: sign.keyId
<keyPass> String 0.1.0

passphrase to decrypt private signing key.

Can be encrypted by standard Maven Password Encryption

Provided key can be stored in plain text, in this case keyPass can be empty.

This value can be delivered by environment variable SIGN_KEY_PASS.


User Property: sign.keyPass
<serverId> String 1.0.0

A serverId from settings.xml which contains configuration for private key used to signing.

server.username
key id - optional value
server.privateKey
path to file contains private key
server.passphrase
password for decrypting private key

NOTICE when used serverId data from property keyId, keyPass and keyFile will not be used.

Environment variable - SIGN_KEY_ID, SIGN_KEY_PASS and SIGN_KEY have always priority and when will be provided will be used first.


User Property: sign.serverId
<skip> boolean 0.1.0 Skip the execution of plugin.
Default: false
User Property: sign.skip
<skipNoKey> boolean 0.1.0 By default execution is skipped if private key is missing.

When set to false and private key is missing error will be reported for current Maven session.


Default: true
User Property: sign.skipNoKey

Parameter Details

<excludes>

A list of files to exclude from being signed. Can contain Ant-style wildcards and double wildcards.
  • Type: java.util.List<java.lang.String>
  • Since: 1.0.0
  • Required: No
  • Default: **/*.md5,**/*.sha1,**/*.sha256,**/*.sha512,**/*.asc

<keyFile>

File with private key used for signing.

This value can be delivered by environment variable SIGN_KEY. Environment variable must contain private key content - not file path for key.

If keyFile path start with ~/ then ~/ will be replace by user home directory - java user.home property

Key can by created and exported by:

     gpg --armor --export-secret-keys

  • Type: java.io.File
  • Since: 0.1.0
  • Required: No
  • User Property: sign.keyFile
  • Default: ${user.home}/.m2/sign-key.asc

<keyId>

keyId used for signing. If not provided first key from keyFile will be taken.

This value can be delivered by environment variable SIGN_KEY_ID.

  • Type: java.lang.String
  • Since: 0.1.0
  • Required: No
  • User Property: sign.keyId

<keyPass>

passphrase to decrypt private signing key.

Can be encrypted by standard Maven Password Encryption

Provided key can be stored in plain text, in this case keyPass can be empty.

This value can be delivered by environment variable SIGN_KEY_PASS.

  • Type: java.lang.String
  • Since: 0.1.0
  • Required: No
  • User Property: sign.keyPass

<serverId>

A serverId from settings.xml which contains configuration for private key used to signing.

server.username
key id - optional value
server.privateKey
path to file contains private key
server.passphrase
password for decrypting private key

NOTICE when used serverId data from property keyId, keyPass and keyFile will not be used.

Environment variable - SIGN_KEY_ID, SIGN_KEY_PASS and SIGN_KEY have always priority and when will be provided will be used first.

  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User Property: sign.serverId

<skip>

Skip the execution of plugin.
  • Type: boolean
  • Since: 0.1.0
  • Required: No
  • User Property: sign.skip
  • Default: false

<skipNoKey>

By default execution is skipped if private key is missing.

When set to false and private key is missing error will be reported for current Maven session.

  • Type: boolean
  • Since: 0.1.0
  • Required: No
  • User Property: sign.skipNoKey
  • Default: true