README

基于 Trello 列表生成 CHANGELOG 文件。

安装

composer require "bigwhoop/trellog":"^1"
vendor\bin\trellog init

使用方法

vendor\bin\trellog generate
vendor\bin\trellog generate > CHANGELOG.md

配置文件

默认情况下，trellog 将在当前工作目录中创建名为 .trellog.yml 的配置文件。如果您文件有不同的名称或位置，可以使用 -c/--config 选项。

注意：此配置文件将包含您的 Trello API 密钥和只读访问令牌。

映射器选项

映射器将 Trello 卡片 映射到 CHANGELOG 条目，Trello 检查列表 映射到 CHANGELOG 部分，Trello 检查列表项 映射到 CHANGELOG 部分项。以下选项可用

mapper:
  options:
    follow_trello_urls: true        # whether to follow Trello Checklist Items that are an URL to a Trello Card
                                    # and instead use the title of this card as the Changelog Section Item name.
    include_archived_cards: false   # whether to also retrieve archived cards or not

打印选项

您可以在配置文件中使用打印选项来自定义生成的输出。

printer:
  options:
    title: The title of the change log
    intro: A text displayed beneath the title. Can be as long as you want it to be.
    versions_whitelist:   # ignore Trello cards not titled ...
      - 1.1.0
      - 1.0.0
    versions_blacklist:   # ignore Trello cards titled ...
      - 2.0.0
    sections_whitelist:   # ignore card checklists not named ...
      - Added
      - Removed
    sections_blacklist:   # ignore card checklists named ...
      - Merges
      - Tests
    print_empty_sections: false   # if true, empty checklists are printed as well
    empty_section_template: Text to output if print_empty_sections is true and a section is empty

许可

MIT。请参阅 LICENSE 文件。