Changelog idea

changelog-2.x.yml

# Encoding: must be UTF-8
# Entries must be reStructuredText (https://en.wikipedia.org/wiki/ReStructuredText)

meta:
  extends:
    file: changelog-1.x.yml
    branch: stable-1.x   # optional, in case previous changelog is in another branch

versions:
  2.0.0:
    minor_changes:
      - "module_1 - added new option ``test``"
      - "module_2 - extended option ``foo``"
      - "All bar modules require library foo >= 3.1.4"
    bugfixes:
      - "module_2 - fix crash when ``bar < 0``"
    upgrade:  # porting guide
      - title: Major Change in Foo Modules
        content: |
          There is a major change in all foo_* modules.
          ...
  2.1.0:
    bugfixes:
      - "module_1 - fix crash when ``bar <= 0``"
  2.1.1:
    bugfixes:
      - "module_3 - error during validation"