-
Notifications
You must be signed in to change notification settings - Fork 108
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
Add CHANGELOG.md file to the zebra git repo #2346
Conversation
This is not urgent at all, it might be good to get this merged in the next couple of weeks before the next tagged release |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good.
We'll have to be careful adding an "Unreleased" section to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good, but let's make sure the updated changelog is included in the new version tag.
We don't need to think about this now but maybe we can add any "relevant" open PRs at the time of updating the CHANGELOG. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good, I'll leave it for @mpguerra to merge
Motivation
Add a CHANGELOG.md file to the repo before the list of tagged releases gets too long.
Solution
PR creates a CHANGELOG.md file with the contents of previously tagged release notes in reverse chronological order (newest releases are listed first)
It also updates the release checklist to include addition of the CHANGELOG.md and its necessary updates.
Closes #2106
Review
@ZcashFoundation/zebra-team
Reviewer Checklist
Follow Up Work
Continuously updating CHANGELOG.md as we tag new releases.
Consider adding an "Unreleased" section to the changelog to document upcoming changes.