bigwhoop/trellog

Generate CHANGELOG files based on Trello lists.

trellog

, _(*1)

, _(*2)

Generate CHANGELOG files based on Trello lists., _(*3)

Installation

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

, _(*4)

Usage

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

, _(*5)

Config file

By default trellog will create config file named .trellog.yml in the current working directory. You can use the -c/--config option if your file has a different name or location., _(*6)

Attention: This conig file will containt your trello API key and read-only access token., _(*7)

Mapper options

The mapper maps Trello Cards to Changelog Entries, Trello Checklists to Changelog Sections and Trello Checklist Items to Changelog Section Items. The following options are available:, _(*8)

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

You can use the printer options in the config file to customize the generated output., _(*9)

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

License

MIT. See LICENSE file., _(*10)