Skip to content

A way to add release summaries #582

Closed
@alexjfisher

Description

@alexjfisher

Hi

It'd be really nice if there was a way to add release 'summaries' when using this tool. Random example.

At first I thought the tool could either examine tags for annotations or maybe query the github 'release' data, but this won't work (people need to generate the changelog and include it in a release before they've tagged the project).

Maybe we could use a .github-changelog-generator.yaml (naming things is hard!) at the root of the repo? I dunno... something along the lines of... (ill thought out example follows)

---
releases:
  'v1.0.1':
    summary: 'This is a small bug fix release only affected Arch Linux users.'
  'v1.0.0':
    summary: 'This release adds support for internationalization.'

Any suggestions?

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions