conex-helper

基于python:3-alpine的Docker镜像，封装了用于管理backplane/conex GitHub仓库的工具程序。

该镜像的源代码托管在GitHub的backplane/conex仓库的conex-helper目录下。

镜像概述与主要用途

conex-helper是一个专为维护backplane/conex仓库设计的工具镜像，提供自动化文档更新、工作流维护和构建元数据生成功能，简化仓库管理流程并确保配置一致性。

核心功能与特性

• update-readme：从容器子目录的README文件更新中心README.md
• update-workflow：更新GitHub Actions工作流文件docker.yml，同步容器子目录列表
• metadata：在Docker构建过程中生成工作流输出，用于后续构建步骤（如基于校验和跳过无需更新的构建）

使用场景与适用范围

适用于backplane/conex仓库的维护者，可用于：

• 自动化聚合子目录文档到中心README
• 保持GitHub Actions工作流与实际容器目录结构同步
• 优化构建流程，避免不必要的重复构建

使用方法与配置说明

命令概览

程序包含三个主要子命令：update-readme、update-workflow和metadata。

通用帮助信息

usage: main.py [-h] [--debug] [--dhuser DHUSER] command ...

用于维护github.com/backplane/conex仓库的工具

位置参数:
  command
    update-readme  从容器子目录的README文件更新中心README
    update-workflow
                   更新GitHub Actions工作流文件'docker.yml'，同步容器子目录列表
    metadata       在容器构建GitHub Action期间调用，生成供后续构建步骤使用的工作流输出

选项:
  -h, --help       显示此帮助消息并退出
  --debug          启用调试输出（默认值：False）
  --dhuser DHUSER  链接镜像时使用的Docker Hub仓库路径（默认值：backplane）

update-readme子命令

用于从容器子目录的README.md文件更新中心README.md。

usage: main.py update-readme [-h] [-i HEADER] readme subdir_readmes [subdir_readmes ...]

位置参数:
  readme                要更新的Markdown文件路径
  subdir_readmes        用于构建的源README.md文件

选项:
  -h, --help            显示此帮助消息并退出
  -i HEADER, --header HEADER
                        要包含在输出开头的头文件（可多个）（默认值：[]）

update-workflow子命令

用于更新GitHub Actions工作流文件docker.yml，同步当前容器子目录列表。

usage: main.py update-workflow [-h] [--workflowfile WORKFLOWFILE] [--basedir BASEDIR] [-l]

选项:
  -h, --help            显示此帮助消息并退出
  --workflowfile WORKFLOWFILE
                        要更新的工作流文件路径（原地更新）（默认值：.github/workflows/docker.yml）
  --basedir BASEDIR     仓库基础路径（默认值：.）
  -l, --list            不进行任何更改，仅打印当前操作文件中的容器列表（默认值：False）

metadata子命令

在Docker构建GitHub Action期间调用，用于生成供后续构建步骤使用的工作流输出。

包括将当前构建上下文的易变校验和与Docker Hub上对应镜像的易变校验和标签进行比较，从而在构建上下文未更改时跳过构建。

usage: main.py metadata [-h] [--forcedbuilds FORCEDBUILDS] [--repo REPO] [--psumlabel PSUMLABEL] [--platforms PLATFORMS] [--platforms-override-file PLATFORMS_OVERRIDE_FILE] [--licenses LICENSES]
                        [--licenses-override-file LICENSES_OVERRIDE_FILE]
                        contextname

位置参数:
  contextname           包含Docker构建上下文的目录名称

选项:
  -h, --help            显示此帮助消息并退出
  --forcedbuilds FORCEDBUILDS
                        逗号分隔的容器上下文列表，无论上下文的易变校验和如何都强制构建（默认值：）
  --repo REPO           镜像仓库，传递给'docker pull'命令（默认值：None）
  --psumlabel PSUMLABEL
                        应用于镜像的命名空间易变校验和标签名称（默认值：be.backplane.image.context_psum）
  --platforms PLATFORMS
                        默认构建平台列表（默认值：linux/amd64,linux/arm64,linux/arm/v7）
  --platforms-override-file PLATFORMS_OVERRIDE_FILE
                        上下文目录中列出构建平台的文件名称（默认值：.build_platforms.txt）
  --licenses LICENSES   主要镜像内容的默认SPDX许可证表达式（默认值：Various Open Source）
  --licenses-override-file LICENSES_OVERRIDE_FILE
                        上下文目录中列出SPDX许可证表达式的文件名称（默认值：LICENSES.txt）

交互式使用

以下shell函数可辅助交互式运行此镜像：

conex_helper() {
  docker run \
    --rm \
    --interactive \
    --tty \
    --volume "$(pwd):/work" \
    "backplane/conex-helper" \
    "$@"
}