Confluence Publisher 使用教程

1. 项目目录结构及介绍

Confluence Publisher 的项目目录结构如下：

confluence-publisher/
├── asciidoc-confluence-publisher-cli
├── asciidoc-confluence-publisher-client
├── asciidoc-confluence-publisher-converter
├── asciidoc-confluence-publisher-doc
├── asciidoc-confluence-publisher-docker
├── asciidoc-confluence-publisher-maven-plugin
├── .circleci
├── .idea
├── .mvn/
├── .gitignore
├── CONTRIBUTING.md
├── LICENSE.txt
├── README.adoc
├── code-signing-key.asc.enc
├── importGpgKey.sh
├── mvnw
├── mvnw.cmd
├── pom.xml
├── publishWithDockerImage.sh
└── waitForConfluenceStartup.sh

• asciidoc-confluence-publisher-cli: AsciiDoc 转换为 Confluence 格式的命令行工具。
• asciidoc-confluence-publisher-client: Confluence 发布客户端。
• asciidoc-confluence-publisher-converter: AsciiDoc 到 Confluence 的转换器。
• asciidoc-confluence-publisher-doc: 项目文档。
• asciidoc-confluence-publisher-docker: Docker 镜像相关文件。
• asciidoc-confluence-publisher-maven-plugin: Maven 插件。
• .circleci: 持续集成配置文件。
• .idea: IntelliJ IDEA 项目配置文件。
• .mvn/: Maven 项目配置文件。
• .gitignore: Git 忽略文件列表。
• CONTRIBUTING.md: 贡献指南。
• LICENSE.txt: 项目许可证文件。
• README.adoc: 项目自述文档。
• code-signing-key.asc.enc: 加密的代码签名密钥。
• importGpgKey.sh: 导入 GPG 密钥的脚本。
• mvnw 和 mvnw.cmd: Maven 包装器脚本。
• pom.xml: Maven 项目对象模型文件。
• publishWithDockerImage.sh: 使用 Docker 镜像发布的脚本。
• waitForConfluenceStartup.sh: 等待 Confluence 启动的脚本。

2. 项目的启动文件介绍

mvnw 或 mvnw.cmd 是用于启动 Maven 项目的脚本。这些脚本会下载并运行 Maven，以便构建和运行项目。

在命令行中，可以通过以下命令启动项目：

mvnw clean install

这将清理之前的构建结果，并重新构建项目。

对于 Docker 镜像的启动，可以使用以下命令：

./publishWithDockerImage.sh

这会使用 Docker 镜像来发布 AsciiDoc 文档到 Confluence。

3. 项目的配置文件介绍

项目的核心配置文件是 pom.xml，这是 Maven 项目的配置文件。它定义了项目的依赖、插件、构建过程等。

以下是一些重要的配置节：

• dependencies: 列出了项目依赖的库和框架。
• build: 定义了项目的构建过程，包括插件和构建步骤。
• plugins: 列出了项目使用的 Maven 插件，例如用于构建、测试和打包的插件。

另一个重要的配置文件是 settings.xml，它位于 .mvn 目录中。这个文件包含 Maven 的本地设置，如仓库和插件配置。

在项目根目录中，confluence_publisher.properties 文件可以用于配置 Confluence 发布的特定参数，如服务器 URL、用户名和密码等。这个文件不会随着项目一起提交，通常在本地开发环境中单独维护。