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.

Sign up for GitHub

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

Jump to bottom

Consistency between GH releases and release-notes.md #333

Open
gaeljw opened this issue Nov 18, 2023 · 0 comments
Open

Consistency between GH releases and release-notes.md #333

gaeljw opened this issue Nov 18, 2023 · 0 comments
Labels
documentation enhancement

Comments

@gaeljw
Copy link
Collaborator

gaeljw commented Nov 18, 2023

I noticed that Release Drafter is used for GH releases but a RELEASE-NOTES.md file is manually maintained.

I'm not sure yet how but it would be nice to keep both consistent.

I would also consider renaming the file to CHANGELOG.md as I know some tools (I have Renovate in mind) uses this file to pick up changelogs but not a strong requirement as I think Renovate also is able to pull changelog from GH releases.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@gaeljw