spring-data-build - Spring Data模块的通用构建基础设施

= Spring Data 构建基础设施 image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-build%2Fmain&subject=Build[link=https://jenkins.spring.io/view/SpringData/job/spring-data-build/] image:https://img.shields.io/badge/Revved%20up%20by-Develocity-06A0CE?logo=Gradle&labelColor=02303A["Revved up by Develocity", link="https://ge.spring.io/scans?search.rootProjectNames=Spring Data Build"]

该存储库包含用于使用 Maven 构建的 Spring Data 模块的通用基础设施。它由一个 resources 项目组成，该项目打包了构建过程中需要的资源，包括用于生成参考文档和 JavaDoc 的 CSS。第二个项目是 parent，可以用作父项目来预配置核心依赖项、属性、参考文档生成，最重要的是适当的分发程序集。

父项目可以用于单模块 Maven 项目或多模块项目。每种设置都需要对项目进行略微不同的配置。

== 行为准则

本项目遵循 link:https://github.com/spring-projects/.github/blob/main/CODE_OF_CONDUCT.md[Spring 行为准则]。通过参与，您应当遵守此行为准则。如遇不可接受的行为，请向 spring-code-of-conduct@pivotal.io 报告。

== 项目设置

=== 通用设置

父项目配置了项目构建的以下方面：

从 spring-data-build-resources 依赖中引入共享资源（图像、CSS、JavaScript）。从 src/asciidoc 目录中名为 index.adoc 的 Asciidoc 文件渲染参考文档。在 distribute 配置文件中，生成两个程序集：一个 ZIP 文件上传到 docs.spring.io（包括可浏览的 javadoc、如前所述的参考文档），内容如下：

[source]

notice.txt

reference -> 从 Asciidoc 生成的参考文档
- html
- pdf
- epub
api -> JavaDoc

生成第二个 ZIP 文件，上传到 docs.spring.io，包含所有 Spring 命名空间 XSD。

预配置了以下依赖项：

日志依赖：SLF4j + Commons Logging 桥接器和 Logback 作为测试依赖
测试依赖：JUnit / AssertJ / Hamcrest / Mockito
常用依赖项的版本

=== 单项目设置

如果客户端项目只包含一个项目，只需声明父项目即可：

[source,xml]

org.springframework.data.build spring-data-parent ${most-recent-release-version} ----

请确保将版本号调整为最新的发布版本。设置的第二个也是最后一步是在构建部分激活程序集和 asciidoctor 插件：

[source,xml]

org.apache.maven.plugins maven-assembly-plugin org.asciidoctor asciidoctor-maven-plugin ----

以 https://github.com/spring-projects/spring-data-jpa[Spring Data JPA] 的构建为例。

=== 多项目设置

多模块设置需要更多配置和一些结构设置。

根 pom.xml 需要将 project.type 属性配置为 multi。
Asciidoc 文档源文件需要放在根项目中。
程序集需要在专用子模块（如 distribution）中构建，在该子模块中声明程序集插件（参见单项目设置），并在该模块中将 project.root 属性重新配置为 ${basedir}/..。
在根项目中将 ${dist.id} 配置为基本工件 ID（如 spring-data-mongodb），因为它将作为分发工件、静态资源等的文件名。如果未正确配置，它将默认为工件 ID，通常解析为 ...-parent。

以 https://github.com/spring-projects/spring-data-mongodb[Spring Data MongoDB] 的构建为例。

== 构建配置

执行 clean (dependency:tree) install -Pci 目标以运行构建
执行 clean deploy -Pci,artifactory 目标以将工件部署到 Artifactory
夜间构建可以使用 clean (dependency:tree) deploy -Pdistribute 来发布参考文档

== 附加构建配置文件

ci - 将 JavaDoc 打包为 JAR 以进行分发（需要在 CI 服务器上激活，以确保我们将 JavaDoc 作为 JAR 分发）。
distribute - 创建 Asciidoc 文档。
distribute-schema - 创建模式文件分发。
spring...-next - 将要使用的 Spring 版本配置为下一个 Spring Framework 快照版本。

== 许可证

Spring Data Build 是根据 https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 许可证] 发布的开源软件。