build_secretpad_cn.md

构建命令

开发环境搭建

开发环境依赖

• JDK: 17
• Maven: 3.5+
• Docker

构建 SecretPad

SecrtPad 提供了 Makefile 来构建项目，你可以通过make help命令查看命令帮助，其中 Development 部分提供了构建能力：

Usage:
  make <target>

General
  help              Display this help.

Development
  test              Run tests.
  build             Build scretpad binary.
  image             Build docker image with the manager.
  docs              Build docs.

测试

在 SecretPad 项目根目录下：

执行make test命令，该命令将会执行项目中所有的测试

构建可执行JAR文件

在 SecretPad 项目根目录下：

执行make build命令，该命令将会构建出 SecretPad 的可执行JAR，构建产物会生成在 ./target/ 目录下。

构建 SecretPad Image

在 SecretPad 项目根目录下：

执行make image命令，该命令将会使用 Docker 命令构建出 SecretPad 镜像。目前 SecretPad 暂时仅支持构建 linux/amd64 的 Anolis 镜像。

编译文档

在 SecretPad 项目根目录下：

执行make docs命令，该命令会生成 SecretPad 文档，生成的文档会放在 docs/_build/html 目录，用浏览器打开 docs/_build/html/index.html 就可以查看文档。

该命令依赖于 python 环境，并且已经安装了 pip 工具；编译文档前请提前安装，否则会执行错误。