Skip to content

README.zh.md

Latest commit

 

History

History
90 lines (65 loc) · 4.63 KB

README.zh.md

File metadata and controls

90 lines (65 loc) · 4.63 KB
Raw

certimate plugins

English | 中文

certimate 的外置 deployer 插件集合。每个插件是一个独立二进制，certimate 通过 hashicorp/go-plugin 以 gRPC 子进程的方式启动它，把证书部署到目标平台。新增插件无需改动 certimate 核心。

本仓库同时也是插件市场源：构建插件、发布为 GitHub Release，并产出市场索引 index.json，供 certimate 的插件市场界面列出、安装、更新插件。

仓库结构

plugins/
├── <plugin-name>/        每个插件一个目录
│   ├── manifest.json       身份与市场元数据
│   ├── main.go             plugin.Serve 入口
│   ├── server.go           Deployer 接口实现
│   ├── schema/             form/v1 deploy（及可选 access）表单 schema 与 i18n
│   └── *_test.go
├── _template/            新插件脚手架
├── cmd/
│   ├── genindex/           从各 manifest 重新生成 index.json
│   └── releaseinfo/        把 release 块（sha256/assets）写进 manifest
├── internal/ pkg/        插件共享工具
├── docs/releasing.md     发版机制说明
├── index.json            生成的市场索引（certimate 消费）
└── Makefile

插件结构

每个插件实现 certimate/pkg/plugin 中定义的 Deployer 接口：

  • GetMetadata —— 身份信息：provider type、access type、deploy category、显示名。
  • GetConfigSchema —— form/v1 deploy（及可选 access）schema + i18n。
  • Deploy —— 根据访问配置、部署配置和证书 PEM 执行部署。

manifest.json 携带市场元数据：

字段 含义
provider_type 插件唯一 id（kebab-case）；同时也是目录名和二进制名
access_provider_type 本插件消费的访问凭据类型
version semver 版本号；bump 它才会触发新发版
deploy_category 市场分组（如 cdn、storage、other）
binary 构建出的二进制名
icon 随插件发布的图标文件名
protocol_version 必须与 certimate 插件协议匹配
usages / priority 市场展示提示
release 生成的 GitHub Release 指针（repo/tag/assets/checksums）

新增插件

make init PLUGIN=my-deployer          # 从 _template 生成脚手架

然后编辑 my-deployer/manifest.json（设置 provider_type、access_provider_type、deploy_category、icon 等），在 server.go 实现 Deploy()，并编写 schema/deploy.json。把图标文件（svg/png）放进插件目录，并在 manifest.icon 指向它。

插件可以声明新的 access 类型（添加 schema/access.json），也可以复用已有的（内置或来自其它插件）。

构建与测试

make build PLUGIN=my-deployer         # 当前主机平台二进制 -> dist/<plugin>
make build-all PLUGIN=my-deployer     # 跨平台编译出发布矩阵
make test                             # go test ./...

build-all 产出剥离符号、可复现的二进制（CGO_ENABLED=0 -trimpath -ldflags='-s -w'），命名方式与 certimate 市场下载一致：<plugin>_<os>_<arch>（Windows 为 <plugin>_windows_amd64.exe），覆盖 linux/amd64、linux/arm64、darwin/amd64、darwin/arm64、windows/amd64。

发版

发版是 change-driven（按改动驱动）+ version-gated（按版本号卡控）。push 到 main 时，release 工作流检测哪些插件发生了变化；对每个 build-affecting 改动且已 bump version 的插件，跨平台编译、发布 GitHub Release（tag <provider_type>/v<version>）、计算各平台 SHA256 校验、并把 release 块写入 manifest。随后 genindex 重新生成 index.json，让 certimate 市场能解析和校验下载。

  • 发一个改动：改代码、在插件 manifest.json 里 bump version、push 到 main。
  • build-affecting 改动（Go 源码、go.mod/go.sum、schema/）不 bump 版本会让本次运行失败。
  • 仅元数据改动（图标、显示名）只会重新生成索引，不发版。

完整流程与信任前提见 docs/releasing.md。

工具

  • make index → cmd/genindex 从所有 manifest 重新生成 index.json。
  • cmd/releaseinfo 计算校验和并写入 release 块（发版工作流使用）。
  • make clean 清除 dist/。

环境要求

  • Go 1.25+（GOTOOLCHAIN=auto 会自动拉取所需工具链）。
  • 依赖 github.com/certimate-go/certimate/pkg/plugin 提供 Deployer 接口与握手协议。