aeonphp/automation

aeonphp/automation Docker镜像文档

镜像概述和主要用途

aeonphp/automation 是一个基于 https://github.com/aeon-php/automation 项目的Docker镜像，提供命令行（CLI）工具，用于从GitHub项目的Pull Requests（PR）描述或提交消息中生成符合 keepachangelog.com 格式的变更日志（Changelog）。其核心用途是简化项目变更日志的生成流程，实现自动化、标准化的文档维护。

核心功能和特性

• GitHub项目支持：针对任意GitHub公开/私有项目生成变更日志。
• 多数据源：支持从PR描述或提交消息中提取变更信息。
• 标准化格式：生成的变更日志严格遵循 keepachangelog.com 规范，包含版本、变更类型（新增、修改、修复等）及详细描述。
• CLI操作：通过简洁的命令行指令完成配置与生成，易于集成到脚本或CI/CD流程。

使用场景和适用范围

• 开发团队：在项目发布阶段自动生成变更日志，替代手动编写，减少重复工作。
• 开源项目：需向社区清晰展示版本变更内容，符合开源文档规范。
• CI/CD集成：作为自动化流程的一部分，在构建或发布环节自动更新变更日志文件。
• 私有项目：需规范化团队内部变更记录，便于版本回溯和协作。

使用方法和配置说明

镜像拉取

通过Docker Hub拉取最新镜像：

bash
docker pull aeonphp/automation:latest

支持的标签：aeonphp/automation:latest（当前唯一稳定标签）。

基本命令

1. 显示帮助信息

查看工具支持的命令列表及参数说明：

bash
# 列出所有可用命令
docker run -t --rm aeonphp/automation list

# 查看全局帮助（含命令用法）
docker run -t --rm aeonphp/automation --help

2. 生成变更日志

核心命令为 changelog:generate，需指定目标GitHub项目（格式：<owner>/<repo>）。

示例：生成公开项目变更日志
为 aeon-php/automation 项目生成未发布的变更日志（默认输出到stdout）：

bash
docker run -t --rm aeonphp/automation changelog:generate aeon-php/automation

高级配置

私有项目访问（需认证）

若目标GitHub项目为私有仓库，需通过环境变量 GITHUB_TOKEN 传入GitHub个人访问令牌（PAT，需包含 repo 权限）：

bash
docker run -t --rm -e GITHUB_TOKEN="your_github_pat" aeonphp/automation changelog:generate <private-owner>/<private-repo>

输出到文件

默认情况下，变更日志输出到标准输出（stdout）。如需保存到文件，可通过Docker挂载本地目录并指定输出路径：

bash
# 将生成的变更日志保存到本地当前目录的 CHANGELOG.md
docker run -t --rm -v $(pwd):/app aeonphp/automation changelog:generate aeon-php/automation > /app/CHANGELOG.md

命令参数说明

changelog:generate 命令的核心参数：

注意事项

• 网络要求：容器需访问GitHub API，确保Docker环境可连接互联网。
• 令牌权限：私有项目的 GITHUB_TOKEN 需包含 repo 作用域，公开项目无需令牌。
• 输出格式：生成的内容严格遵循 keepachangelog.com 规范，包含 ## [Unreleased] 及具体变更类型（如 ### Added、### Fixed 等）。

示例：集成到CI/CD流程

在GitLab CI/CD中，可添加如下 .gitlab-ci.yml 配置，实现发布前自动更新变更日志：

yaml
generate_changelog:
  stage: pre-release
  image: aeonphp/automation:latest
  variables:
    GITHUB_TOKEN: $GITHUB_PAT  # 从CI/CD变量中传入私有令牌
  script:
    - docker run -t --rm -e GITHUB_TOKEN="$GITHUB_TOKEN" aeonphp/automation changelog:generate my-org/my-project > CHANGELOG.md
  artifacts:
    paths:
      - CHANGELOG.md

参考链接

• 项目源码：https://github.com/aeon-php/automation
• 变更日志规范：keepachangelog.com