gpg:签名和部署文件

全名:

org.apache.maven.plugins:maven-gpg-plugin:1.4:sign-and-deploy-file

说明:

签署工件并将工件安装在远程存储库中。

属性:

  • 目标是线程安全的并支持并行构建。
  • 自版本:1.0-beta-4。

必需参数

姓名 类型 自从 描述
文件 文件 1.0-beta-4 要部署的文件。
存储库 ID 细绳 1.0-beta-4 服务器 ID 映射到settings.xml的 <server> 部分下的 <id> 上 。在大多数情况下,此参数将是身份验证所必需的。
默认值为:远程存储库。
网址 细绳 1.0-beta-4 将部署工件的 URL。
即( file:///C:/m2-repo 或 scp://host.com/path/to/repo )

可选参数

姓名 类型 自从 描述
工件 ID 细绳 1.0-beta-4 要部署的工件的 ArtifactId。如果指定,则从 POM 文件中检索。
asc目录 文件 1.0-beta-4 存储签名文件的目录。
分类器 细绳 1.0-beta-4 将分类器添加到工件
分类器 细绳 1.0-beta-4 一个逗号分隔的分类器列表,用于部署每个额外的辅助工件。如果files或types中的条目数不匹配,则会引发错误。
默认密钥环 布尔值 1.2 是否将 gpg 主目录中的默认密钥环添加到已使用的密钥环列表中。
默认值为:true。
描述 细绳 1.0-beta-4 传递给生成的 POM 文件的描述(在 generatePom=true 的情况下)。
可执行的 细绳 1.1 用于工件签名的 GnuPG 可执行文件的路径。默认为“gpg”或“gpg.exe”,具体取决于操作系统。
文件 细绳 1.0-beta-4 每个要部署的额外辅助工件的逗号分隔文件列表。如果types或classifiers中的条目数不匹配,则会引发错误。
生成Pom 布尔值 1.0-beta-4 上传此工件的 POM。如果没有提供 pomFile 参数,将生成默认 POM。
默认值为:true。
组 ID 细绳 1.0-beta-4 要部署的工件的 GroupId。如果指定,则从 POM 文件中检索。
主目录 文件 1.0 gpg 将从中加载密钥环的目录。如果未指定,gpg 将使用为其安装配置的值,例如 ~/.gnupg或%APPDATA%/gnupg。
文档 文件 1.3 工件的捆绑 API 文档。
键名 细绳 1.0-beta-4 要签名的密钥的“名称”。作为--local-user传递给 gpg 。
包装 细绳 1.0-beta-4 要部署的工件的类型。如果指定,则从 POM 文件中检索。如果未通过命令行或 POM 指定,则默认为文件扩展名。
密码 细绳 1.0-beta-4 签名时使用的密码。
pom文件 文件 1.0-beta-4 与主要工件一起部署的现有 POM 文件的位置,由 ${file} 参数给出。
公开钥匙圈 细绳 1.2 要添加到密钥环列表的公共密钥环的路径。默认情况下,只考虑 gpg 主目录中的pubring.gpg。使用此选项( 如果需要,还可以使用defaultKeyring)来使用不同的公钥。注意:相对路径是针对 gpg 的主目录而不是项目基目录解析的。
存储库布局 细绳 1.0-beta-4 要部署到的远程存储库布局的类型。尝试 使用 Maven 1.x 风格的存储库布局的legacy。
默认值为:默认值。
retryFailedDeploymentCount 整数 1.3 用于控制失败部署在放弃和失败之前重试多少次的参数。如果指定了 1-10 范围之外的值,它将被拉到 1-10 范围内的最接近的值。
默认值为:1。
秘密钥匙圈 细绳 1.2 要添加到密钥环列表的密钥环的路径。默认情况下,只考虑 gpg 主目录中的secring.gpg。使用此选项(如果需要,与 publicKeyring和defaultKeyring结合使用)使用不同的密钥。注意:相对路径是针对 gpg 的主目录而不是项目基目录解析的。
来源 文件 1.3 工件的捆绑源。
类型 细绳 1.0-beta-4 每个要部署的额外辅助工件的类型的逗号分隔列表。如果文件或分类器中的条目数不匹配,则会引发错误。
唯一版本 布尔值 1.0-beta-4 是否部署具有唯一版本的快照。
默认值为:true。
更新发布信息 布尔值 1.3 用于更新元数据以使工件成为发布的参数。
默认值为:false。
使用代理 布尔值 1.0-beta-4 将--use-agent或--no-use-agent传递给 gpg。如果使用代理,则密码是可选的,因为代理将提供它。对于 gpg2,指定 true 为 --no-use-agent 已在 gpg2 中删除,并且不再要求输入密码。
默认值为:false。
版本 细绳 1.0-beta-4 要部署的工件的版本。如果指定,则从 POM 文件中检索。

参数详情

工件编号:

要部署的工件的 ArtifactId。如果指定,则从 POM 文件中检索。
  • 类型:java.lang.String
  • 自:1.0-beta-4
  • 要求:否
  • 表达式:${artifactId}

asc目录:

存储签名文件的目录。
  • 类型:java.io.File
  • 自:1.0-beta-4
  • 要求:否
  • 表达式:${gpg.ascDirectory}

分类器:

将分类器添加到工件
  • 类型:java.lang.String
  • 自:1.0-beta-4
  • 要求:否
  • 表达式:${分类器}

分类器:

一个逗号分隔的分类器列表,用于部署每个额外的辅助工件。如果files或types中的条目数不匹配,则会引发错误。
  • 类型:java.lang.String
  • 自:1.0-beta-4
  • 要求:否
  • 表达式:${分类器}

默认密钥环:

是否将 gpg 主目录中的默认密钥环添加到已使用的密钥环列表中。
  • 类型:布尔值
  • 从: 1.2
  • 要求:否
  • 表达式:${gpg.defaultKeyring}
  • 默认值:真

描述:

传递给生成的 POM 文件的描述(在 generatePom=true 的情况下)。
  • 类型:java.lang.String
  • 自:1.0-beta-4
  • 要求:否
  • 表达式:${generatePom.description}

可执行文件:

用于工件签名的 GnuPG 可执行文件的路径。默认为“gpg”或“gpg.exe”,具体取决于操作系统。
  • 类型:java.lang.String
  • 从: 1.1
  • 要求:否
  • 表达式:${gpg.executable}

文件:

要部署的文件。
  • 类型:java.io.File
  • 自:1.0-beta-4
  • 要求:是
  • 表达式:${file}

文件:

每个要部署的额外辅助工件的逗号分隔文件列表。如果types或classifiers中的条目数不匹配,则会引发错误。
  • 类型:java.lang.String
  • 自:1.0-beta-4
  • 要求:否
  • 表达式:${files}

生成Pom:

上传此工件的 POM。如果没有提供 pomFile 参数,将生成默认 POM。
  • 类型:布尔值
  • 自:1.0-beta-4
  • 要求:否
  • 表达式:${generatePom}
  • 默认值:真

组号:

要部署的工件的 GroupId。如果指定,则从 POM 文件中检索。
  • 类型:java.lang.String
  • 自:1.0-beta-4
  • 要求:否
  • 表达式:${groupId}

主目录:

gpg 将从中加载密钥环的目录。如果未指定,gpg 将使用为其安装配置的值,例如 ~/.gnupg或%APPDATA%/gnupg。
  • 类型:java.io.File
  • 从: 1.0
  • 要求:否
  • 表达式:${gpg.homedir}

文档:

工件的捆绑 API 文档。
  • 类型:java.io.File
  • 从: 1.3
  • 要求:否
  • 表达式:${javadoc}

键名:

要签名的密钥的“名称”。作为--local-user传递给 gpg 。
  • 类型:java.lang.String
  • 自:1.0-beta-4
  • 要求:否
  • 表达式:${gpg.keyname}

包装:

要部署的工件的类型。如果指定,则从 POM 文件中检索。如果未通过命令行或 POM 指定,则默认为文件扩展名。
  • 类型:java.lang.String
  • 自:1.0-beta-4
  • 要求:否
  • 表达式:${包装}

密码:

签名时使用的密码。
  • 类型:java.lang.String
  • 自:1.0-beta-4
  • 要求:否
  • 表达式:${gpg.passphrase}

pom文件:

与主要工件一起部署的现有 POM 文件的位置,由 ${file} 参数给出。
  • 类型:java.io.File
  • 自:1.0-beta-4
  • 要求:否
  • 表达式:${pomFile}

公共密钥环:

要添加到密钥环列表的公共密钥环的路径。默认情况下,只考虑 gpg 主目录中的pubring.gpg。使用此选项( 如果需要,还可以使用defaultKeyring)来使用不同的公钥。注意:相对路径是针对 gpg 的主目录而不是项目基目录解析的。
  • 类型:java.lang.String
  • 从: 1.2
  • 要求:否
  • 表达式:${gpg.publicKeyring}

存储库ID:

服务器 ID 映射到settings.xml的 <server> 部分下的 <id> 上 。在大多数情况下,此参数将是身份验证所必需的。
  • 类型:java.lang.String
  • 自:1.0-beta-4
  • 要求:是
  • 表达式:${repositoryId}
  • 默认值:远程存储库

存储库布局:

要部署到的远程存储库布局的类型。尝试 使用 Maven 1.x 风格的存储库布局的legacy。
  • 类型:java.lang.String
  • 自:1.0-beta-4
  • 要求:否
  • 表达式:${repositoryLayout}
  • 默认:默认

重试失败部署计数:

用于控制失败部署在放弃和失败之前重试多少次的参数。如果指定了 1-10 范围之外的值,它将被拉到 1-10 范围内的最接近的值。
  • 类型:整数
  • 从: 1.3
  • 要求:否
  • 表达式:${retryFailedDeploymentCount}
  • 默认值:1

密钥环:

要添加到密钥环列表的密钥环的路径。默认情况下,只考虑 gpg 主目录中的secring.gpg。使用此选项(如果需要,与 publicKeyring和defaultKeyring结合使用)使用不同的密钥。注意:相对路径是针对 gpg 的主目录而不是项目基目录解析的。
  • 类型:java.lang.String
  • 从: 1.2
  • 要求:否
  • 表达式:${gpg.secretKeyring}

来源:

工件的捆绑源。
  • 类型:java.io.File
  • 从: 1.3
  • 要求:否
  • 表达式:${sources}

类型:

每个要部署的额外辅助工件的类型的逗号分隔列表。如果文件或分类器中的条目数不匹配,则会引发错误。
  • 类型:java.lang.String
  • 自:1.0-beta-4
  • 要求:否
  • 表达式:${types}

唯一版本:

是否部署具有唯一版本的快照。
  • 类型:布尔值
  • 自:1.0-beta-4
  • 要求:否
  • 表达式:${uniqueVersion}
  • 默认值:真

更新发布信息:

用于更新元数据以使工件成为发布的参数。
  • 类型:布尔值
  • 从: 1.3
  • 要求:否
  • 表达式:${updateReleaseInfo}
  • 默认值:假

网址:

将部署工件的 URL。
即( file:///C:/m2-repo 或 scp://host.com/path/to/repo )
  • 类型:java.lang.String
  • 自:1.0-beta-4
  • 要求:是
  • 表达式:${url}

使用代理:

将--use-agent或--no-use-agent传递给 gpg。如果使用代理,则密码是可选的,因为代理将提供它。对于 gpg2,指定 true 为 --no-use-agent 已在 gpg2 中删除,并且不再要求输入密码。
  • 类型:布尔值
  • 自:1.0-beta-4
  • 要求:否
  • 表达式:${gpg.useagent}
  • 默认值:假

版本:

要部署的工件的版本。如果指定,则从 POM 文件中检索。
  • 类型:java.lang.String
  • 自:1.0-beta-4
  • 要求:否
  • 表达式:${版本}