用法
您可以按以下方式使用 Logging Parent
-
在您的
pom.xml中添加org.apache.logging:logging-parent:11.0.0作为parent -
您可能需要将
.mvn/jvm.config添加到您的项目中。请参阅 此示例。 -
检查
./mvnw verify是否成功，否则进行必要的更改 -
复制并调整支持文件（
.gitignore、.github/workflows/build.yaml等） -
复制并调整 Log4j 变更日志文件
-
src/changelog/.<majorVersion>.x.x/.release-notes.adoc.ftl -
src/changelog/.changelog.adoc.ftl -
src/changelog/.index.adoc.ftl
-
-
为了创建一个基于 Antora 的网站
-
复制以下文件并进行调整
-
antora-playbook.yaml -
package.json -
src/site/antora/antora.yml -
src/site/antora/.antora.yml -
src/site/antora/modules/ROOT/pages/release-notes.adoc
-
-
使用
./mvnw site构建网站 -
通过将浏览器指向
target/site检查生成的网站
-
网站部署
使用 deploy-site-reusable.yaml 可重用 GitHub Actions 工作流，您可以自动执行暂存和生产环境的网站部署。
示例：Logging Parent 分支方案
请参阅 Logging Parent 的 deploy-site.yaml 如何使用
<source-branch>-site-<environment>-out分支命名约定
- 暂存网站
- 生产网站
- 发布暂存网站
- 分支
main -
包含构建暂存网站的源代码（即 AsciiDoc 文件）。
- 分支
main-site-stg-out -
由针对
main的更改触发的流程自动填充。它包含暂存网站的内容（即 HTML 文件）。简而言之，CI 构建main并将生成的target/site复制到main-site-stg-out。 - 分支
main-site-pro -
包含构建生产网站的源代码（即 AsciiDoc 文件）。它由维护人员手动填充。例如，
-
发布后，发布标签将合并到
main-site-pro -
当
main中存在可以也进入生产网站的次要网站修复时，它们会被cherry-pick到main-site-pro上 -
当存在仅生产网站修复时，它们会被提交到
main-site-pro
-
- 分支
main-site-pro-out -
由针对
main-site-pro的更改触发的流程自动填充。它包含生产网站的内容（即 HTML 文件）。简而言之，CI 构建main-site-pro并将生成的target/site复制到main-site-pro-out。 - 分支
release/<version> -
包含构建发布暂存网站的源代码（即 AsciiDoc 文件）。它由发布经理在发布期间手动填充。
- 分支
release/<version>-site-stg-out -
由针对
release/<version>的更改触发的流程自动填充。它包含发布暂存网站的内容（即 HTML 文件）。简而言之，CI 构建release/<version>并将生成的target/site复制到release/<version>-site-stg-out。