Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
tmarkley opened this issue Jul 6, 2021 · 4 comments
Closed

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

tmarkley opened this issue Jul 6, 2021 · 4 comments
Labels
discuss docs Improvements or additions to documentation proposal v3.0.0 versioning

Comments

@tmarkley
Copy link
Contributor

tmarkley commented Jul 6, 2021

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)

@tmarkley tmarkley added docs Improvements or additions to documentation enhancement New feature or request versioning discuss proposal labels Jul 6, 2021
@tmarkley tmarkley removed the enhancement New feature or request label Jul 6, 2021
@galangel
Copy link
Contributor

galangel commented Jul 7, 2021

Good suggestion

@dblock
Copy link
Member

dblock commented Jul 7, 2021

+1, and I would want this to be in https://keepachangelog.com/en/1.0.0/ format

A stretch idea would be to both enforce the format and require changelog entries on PRs, thus not needing to do any work for releases notes before releases. I use https://github.com/dblock/danger-changelog for this.

@zhongnansu
Copy link
Member

Change log makes auto backport PRs fail a lot, since all PRs now will touch the same file CHANGELOG.md, and the chance of a conflict becomes higher.

@joshuarrrr
Copy link
Member

closing this proposal, as most of the suggestions have been implemented, albeit at significant cost to developers and maintainers.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discuss docs Improvements or additions to documentation proposal v3.0.0 versioning
Projects
None yet
Development

No branches or pull requests

6 participants