scm-发布:发布-scm

全名

org.apache.maven.plugins:maven-scm-publish-plugin:3.1.0:publish-scm

说明

将内容发布到 scm。默认情况下,内容取自默认站点暂存目录 ${project.build.directory}/staging。无需项目即可使用,因此可用于使用任何内容更新任何 SCM。

属性

  • 作为聚合器插件执行。

必需参数

姓名 类型 自从 描述
<pubScmUrl> 细绳 - scm 发布树的位置: scm:<scm_provider><delimiter><provider_specific_part>。示例: scm:svn:https://svn.apache.org/repos/infra/websites/production/maven/content/plugins/maven-scm-publish-plugin-LATEST/
默认值为${project.distributionManagement.网站.url}
用户属性是scmpublish.pubScmUrl

可选参数

姓名 类型 自从 描述
<添加唯一目录> 布尔值 - 在单独的 SCM 命令中添加每个目录:如果 SCM 不支持在一个命令中添加子目录,则可能需要这样做。
默认值为false
<自动远程路径创建> 布尔值 - 配置 svn 自动远程 url 创建。
默认值为true
用户属性是scmpublish.automaticRemotePathCreation
<签入评论> 细绳 - 本出版物的 SCM 日志/签入注释。
默认值为项目 ${project.name} 的站点签入
用户属性是scmpublish.checkinComment
<结帐目录> 文件 - 完成 scm 签出的位置。默认情况下,scm checkout 在 build (target) 目录中完成,每个 mvn clean都会删除该目录。为了避免这种情况并获得更好的性能,请在构建结构之外配置此位置并将 tryUpdate设置为true。有关详细信息,请参阅提高 SCM 结帐性能
默认值为${project.build.directory}/scmpublish-checkout
用户属性是scmpublish.checkoutDirectory
<内容> 文件 - 要发布的内容。
默认值为${project.build.directory}/staging
用户属性是scmpublish.content
<干运行> 布尔值 - 显示添加、删除和更改的文件列表,但不执行任何实际的 SCM 操作。
用户属性是scmpublish.dryRun
<不包括> 细绳 - 要从 scm 树中排除的模式。
<extraNormalizeExtensions> 细绳[] - 用于规范行尾的额外文件扩展名(将添加到默认htmlcssjs列表中)
<ignorePathsToDelete> 细绳[] - 检查要删除的内容时不删除的路径集合。如果您的站点具有由其他机制/构建发布的子目录
<包括> 细绳 - 要包含在 scm 树中的模式。
<本地结帐> 布尔值 - 使用本地签出而不是从上游存储库进行签出。警告:这仅适用于支持 file:// 协议的分布式 SCM。TODO:我们应该考虑为通过 Modello 提供的各种 SCM 提供程序设置默认值!
默认值为false
用户属性是localCheckout
<密码> 细绳 - 要使用的 SCM 密码。
用户属性是密码
<providerImplementations> 地图 - SCM 提供程序实现列表。键是提供者类型,例如。 简历。值是提供者实现(提供者的角色提示),例如。cvscvs_native
<scm分支> 细绳 - 单片机分支使用。对于 github,您必须使用 gh-pages进行配置。
用户属性是scmpublish.scm.branch
<服务器ID> 细绳 - 在 settings.xml 中指定的 serverId,应该用于身份验证。
<站点输出编码> 细绳 - 站点插件的 outputEncoding 参数。如果这与站点插件使用的值不匹配,此插件将损坏您的站点。
默认值为${project.reporting.outputEncoding}
用户属性是outputEncoding
<skipCheckin> 布尔值 - 运行添加和删除命令,但将实际签入留给用户手动运行。
用户属性是scmpublish.skipCheckin
<skipDeletedFiles> 布尔值 - 不删除文件到 scm
默认值为false
用户属性是scmpublish.skipDeletedFiles
<跳过部署> 布尔值 - 将此设置为“true”以跳过站点部署。
默认值为false
用户属性是scmpublish.skipDeploy
别名是maven.site.deploy.skip
<子目录> 细绳 - 在${checkoutDirectory}中发布内容的位置 。默认情况下,内容复制到${checkoutDirectory}的根目录。
用户属性是scmpublish.subDirectory
<尝试更新> 布尔值 - 如果结帐目录存在并且此标志被激活,插件将尝试 SCM 更新而不是删除然后结帐。
默认值为false
用户属性是scmpublish.tryUpdate
<用户名> 细绳 - 要使用的 SCM 用户名。
用户属性是用户名

参数详情

<添加唯一目录>

在单独的 SCM 命令中添加每个目录:如果 SCM 不支持在一个命令中添加子目录,则可能需要这样做。
  • 类型布尔值
  • 要求
  • 默认值

<自动远程路径创建>

配置 svn 自动远程 url 创建。
  • 类型布尔值
  • 要求
  • 用户属性scmpublish.automaticRemotePathCreation
  • 默认值

<签入评论>

本出版物的 SCM 日志/签入注释。
  • 类型java.lang.String
  • 要求
  • 用户属性scmpublish.checkinComment
  • 默认值项目 ${project.name} 的站点签入

<结帐目录>

完成 scm 签出的位置。默认情况下,scm checkout 在 build (target) 目录中完成,每个 mvn clean都会删除该目录。为了避免这种情况并获得更好的性能,请在构建结构之外配置此位置并将 tryUpdate设置为true。有关详细信息,请参阅提高 SCM 结帐性能
  • 类型java.io.File
  • 要求
  • 用户属性scmpublish.checkoutDirectory
  • 默认值${project.build.directory}/scmpublish-checkout

<内容>

要发布的内容。
  • 类型java.io.File
  • 要求
  • 用户属性scmpublish.content
  • 默认值${project.build.directory}/staging

<干运行>

显示添加、删除和更改的文件列表,但不执行任何实际的 SCM 操作。
  • 类型布尔值
  • 要求
  • 用户属性scmpublish.dryRun

<不包括>

要从 scm 树中排除的模式。
  • 类型java.lang.String
  • 要求

<extraNormalizeExtensions>

用于规范行尾的额外文件扩展名(将添加到默认htmlcssjs列表中)
  • 类型java.lang.String[]
  • 要求

<ignorePathsToDelete>

检查要删除的内容时不删除的路径集合。如果您的站点具有由其他机制/构建发布的子目录
  • 类型java.lang.String[]
  • 要求

<包括>

要包含在 scm 树中的模式。
  • 类型java.lang.String
  • 要求

<本地结帐>

使用本地签出而不是从上游存储库进行签出。警告:这仅适用于支持 file:// 协议的分布式 SCM。TODO:我们应该考虑为通过 Modello 提供的各种 SCM 提供程序设置默认值!
  • 类型布尔值
  • 要求
  • 用户属性localCheckout
  • 默认值

<密码>

要使用的 SCM 密码。
  • 类型java.lang.String
  • 要求
  • 用户属性密码

<providerImplementations>

SCM 提供程序实现列表。键是提供者类型,例如。 简历。值是提供者实现(提供者的角色提示),例如。cvscvs_native
  • 类型java.util.Map
  • 要求

<pubScmUrl>

scm 发布树的位置: scm:<scm_provider><delimiter><provider_specific_part>。示例: scm:svn:https://svn.apache.org/repos/infra/websites/production/maven/content/plugins/maven-scm-publish-plugin-LATEST/
  • 类型java.lang.String
  • 要求
  • 用户属性scmpublish.pubScmUrl
  • 默认值${project.distributionManagement.site.url}

<scm分支>

单片机分支使用。对于 github,您必须使用 gh-pages进行配置。
  • 类型java.lang.String
  • 要求
  • 用户属性scmpublish.scm.branch

<服务器ID>

在 settings.xml 中指定的 serverId,应该用于身份验证。
  • 类型java.lang.String
  • 要求

<站点输出编码>

站点插件的 outputEncoding 参数。如果这与站点插件使用的值不匹配,此插件将损坏您的站点。
  • 类型java.lang.String
  • 要求
  • 用户属性输出编码
  • 默认值${project.reporting.outputEncoding}

<skipCheckin>

运行添加和删除命令,但将实际签入留给用户手动运行。
  • 类型布尔值
  • 要求
  • 用户属性scmpublish.skipCheckin

<skipDeletedFiles>

不要将文件删除到 scm
  • 类型布尔值
  • 要求
  • 用户属性scmpublish.skipDeletedFiles
  • 默认值

<跳过部署>

将此设置为“true”以跳过站点部署。
  • 类型布尔值
  • 要求
  • 用户属性scmpublish.skipDeploy
  • 默认值
  • 别名maven.site.deploy.skip

<子目录>

在${checkoutDirectory}中发布内容的位置 。默认情况下,内容复制到${checkoutDirectory}的根目录。
  • 类型java.lang.String
  • 要求
  • 用户属性scmpublish.subDirectory

<尝试更新>

如果结帐目录存在并且此标志被激活,插件将尝试 SCM 更新而不是删除然后结帐。
  • 类型布尔值
  • 要求
  • 用户属性scmpublish.tryUpdate
  • 默认值

<用户名>

要使用的 SCM 用户名。
  • 类型java.lang.String
  • 要求
  • 用户属性用户名