Skip to content

[Proposal] Create a changelog to track releases over time #591

@tmarkley

Description

@tmarkley

Is your feature request related to a problem? Please describe.

We currently (i.e. for v1.0.0) generate release notes for each release, but changelogs are often easier to parse/search when dealing with version bumps/upgrades than individual release notes. Having a complete summary of breaking changes, new features, etc. between all previous versions is incredibly useful.

Describe the solution you'd like

We could use something like this to aid in the generation: https://github.com/github-changelog-generator/github-changelog-generator

Describe alternatives you've considered

Some potential alternatives:

Additional context

A great example is mocha, where they include the version number, date, sections in each release, and emojis (a fun bonus feature): https://github.com/mochajs/mocha/blob/master/CHANGELOG.md

I also added a comment in the OpenSearch repo with this suggestion: opensearch-project/OpenSearch#789 (comment)

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