openeuropa/task-runner-changelog

用于生成和处理变更日志的命令。

1.0.1 2021-03-03 08:58 UTC

This package is auto-updated.

Last update: 2024-09-13 02:16:10 UTC


README

Build Status Packagist

Task Runner 命令用于生成和处理变更日志。

这是一个 CLI 命令,它使用 OpenEuropa Taskrunner 生成变更日志。它封装了 github-changelog-generator 项目。

这为以下项目生成变更日志:

  1. 在 GitHub 上公开托管。
  2. 使用 GitHub 问题和建议请求来管理开发。
  3. 在 GitHub 上发布版本。

要求

安装

将项目作为 composer 依赖项添加到需要生成变更日志的项目中

$ composer require openeuropa/task-runner-changelog

使用方法

需要 GitHub 访问令牌。建议为该命令创建一个新的令牌。

以下示例将在项目根目录中的 CHANGELOG.md 文件中生成变更日志。

# Generate a changelog for an unreleased development version.
$ ./vendor/bin/run changelog:generate --token=TOKEN
# Generate a changelog for an upcoming 1.2.3 release.
$ ./vendor/bin/run changelog:generate --token=TOKEN --tag=1.2.3

有关更多信息和其他选项,请参阅内置帮助。

$ ./vendor/bin/run changelog:generate --help

开发

阅读 Task Runner 文档:https://github.com/openeuropa/task-runner/blob/master/README.md