Maven – 部署 Maven 组件参考文档

介绍

本文档提供了在 Maven https://maven.apache.org/网站内部署 Maven 组件参考文档的分步说明。

关于整个网站发布（主要网站内容+组件）的说明，请参见Maven 网站介绍。

概述

自2012年12月起，网站整体使用svnpubsub机制：

组件参考文档发布的工作原理

组件不使用 CMS：组件参考文档是版本化的，并从完整的源代码生成，包括手写内容（如 Maven 主站点）和从源代码生成的内容（javadoc、单元测试结果、集成测试结果......）。

暂存组件参考文档

组件的参考文档在中暂存https://maven.apache.org/xxx-archives/yyy-LATEST/，其中yyy是组件名称，xxx可以是：

组件类型，如shared, plugins, skins, ...（参见/shared-archives/ , /plugins-archives/ , /pom-archives/ , /skins-archives/）
独立组件的组件名称，例如archetype, plugin-tools, surefire, , wagon... _ _ _ _货车档案/）

要发布组件参考文档：

先决条件：如果之前没有完成，最终构建组件，或者某些报告可能会丢失构建或集成信息：
注意：如果您已经准备好发布，您可以简单地切换到target/checkout文件夹并继续执行 2。
```
mvn -Prun-its install
```
构建参考文档：
```
mvn -Preporting site site:stage
```
注意：site:stage仅对多模块组件确实有必要，但在这些说明中无条件添加以使它们尽可能简单。
使用maven-scm-publish-plugin将参考文档暂存到网站生产 svn 区域：（TODO：pom 到 yyy-LATEST 中的配置说明）
```
mvn scm-publish:publish-scm
```
svnpubsub 机制将 svn 制作内容传输到现场制作站点

注意：内容实际上发布到/components/目录，并且在主站点源代码中声明的符号链接resources/**/components.links被 Ant 用于创建从/xxx（= 我们希望用户可见的内容）到/components/xxx（签出的内容）的引用.

发布版本化组件参考文档

在进行发布时，yyy-LATEST上一节中上演的内容需要：

在较新的版本发布到 -LATEST 之前存档到版本化目录，
替换实际的组件参考文档。

这是通过网站生产svn区域的操作完成的：您可以使用组件参考文档助手轻松准备svnmucc命令行。

如果您更喜欢从命令模板手动执行所有操作，您可以使用svn命令执行以下任一操作：

Unix：

SVNPUBSUB=https://svn.apache.org/repos/asf/maven/website/components

svn cp $SVNPUBSUB/xxx-archives/yyy-LATEST $SVNPUBSUB/xxx-archives/yyy-$version -m "Archive versioned site."

svn rm $SVNPUBSUB/xxx/yyy -m "Remove old site."
svn cp $SVNPUBSUB/xxx-archives/yyy-$version $SVNPUBSUB/xxx/yyy -m "Publish new site."

视窗：

set SVNPUBSUB=https://svn.apache.org/repos/asf/maven/website/components

svn cp %SVNPUBSUB%/xxx-archives/yyy-LATEST %SVNPUBSUB%/xxx-archives/yyy-$version -m "Archive versioned site."

svn rm %SVNPUBSUB%/xxx/yyy -m "Remove old site."
svn cp %SVNPUBSUB%/xxx-archives/yyy-$version %SVNPUBSUB%/xxx/yyy -m "Publish new site."

或使用svnmucc命令：

svnmucc -m "Publish yyy $version documentation" \
  -U https://svn.apache.org/repos/asf/maven/website/components \
  cp HEAD xxx-archives/yyy-LATEST xxx-archives/yyy-$version \
  rm xxx/yyy \
  cp HEAD xxx-archives/yyy-LATEST xxx/yyy

更新 Maven 站点中的索引页面

某些组件类型有一个索引页，用于引用同一类型的每个组件。插件（参见索引）、共享（参见索引）、pom（参见索引）和皮肤（参见索引）就是这种情况。

更新页面中组件的版本号和发布日期content/apt/xxx/index.apt。

有关主站点内容编辑的更深入说明，请参阅部署 Maven 网站。

注意：如果您忘记更新索引页面，dist-tool每天都会运行一个报告，当“检查错误”报告不为空时，它会在 notification@maven.ao 上轻轻发送失败通知。