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

Add CHANGELOG.md file to the zebra git repo #2346

Merged
merged 7 commits into from
Jun 22, 2021
Merged

Add CHANGELOG.md file to the zebra git repo #2346

merged 7 commits into from
Jun 22, 2021

Conversation

mpguerra
Copy link
Contributor

@mpguerra mpguerra commented Jun 18, 2021

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

  • CHANGELOG.md displays correctly
  • New release checklist items make sense and are done in the correct order

Follow Up Work

Continuously updating CHANGELOG.md as we tag new releases.
Consider adding an "Unreleased" section to the changelog to document upcoming changes.

@mpguerra mpguerra marked this pull request as draft June 18, 2021 10:39
@mpguerra mpguerra changed the title Changelog Add CHANGELOG.md file to the zebra git repo Jun 18, 2021
@mpguerra mpguerra requested a review from a team June 18, 2021 11:07
@mpguerra mpguerra marked this pull request as ready for review June 18, 2021 11:07
@mpguerra
Copy link
Contributor Author

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

oxarbitrage
oxarbitrage previously approved these changes Jun 18, 2021
Copy link
Contributor

@oxarbitrage oxarbitrage left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.

@teor2345
Copy link
Contributor

Consider adding an "Unreleased" section to the changelog to document upcoming changes.

We'll have to be careful adding an "Unreleased" section to CHANGELOG.md. If we update it in every PR, then there will be a lot of merge conflicts.

Copy link
Contributor

@teor2345 teor2345 left a 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.

@mpguerra
Copy link
Contributor Author

Consider adding an "Unreleased" section to the changelog to document upcoming changes.

We'll have to be careful adding an "Unreleased" section to CHANGELOG.md. If we update it in every PR, then there will be a lot of merge conflicts.

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.

@mpguerra mpguerra requested a review from teor2345 June 21, 2021 15:00
Copy link
Contributor

@teor2345 teor2345 left a 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

@mpguerra mpguerra merged commit e87933e into main Jun 22, 2021
@mpguerra mpguerra deleted the changelog branch June 22, 2021 13:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a CHANGELOG.md file to Zebra
3 participants