-
Notifications
You must be signed in to change notification settings - Fork 11.8k
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
Reorganize changelog entries for 5.1 #5131
Reorganize changelog entries for 5.1 #5131
Conversation
As discussed in our call, we should consider whether we want to use this format in later releases. For now it's looking good but I need to take a look to the tests since the gas estimation is failing (not a big deal) |
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.
I consider that an ordered changelog is more readable, but I also think there should be a consistent format. We've given priority to the breaking changes in the past (listing them at first) and for 5.0 each category is a folder.
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.
I went ahead and pushed the suggested changes, I think this way the diff reads way better and we keep consistent order.
Last time the gas comparison failed but I'm guessing is because there's no report to compare against. Should be fine since we're not changing code in this PR
We'll wait before cherry-picking everything from #5139, otherwise the changelog will regenerate |
aba9ff6
to
878a26c
Compare
1165d61
to
e740579
Compare
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.
CI will likely fail given there's nothing to compare gas against (in compareGasReports.js
). LGTM
2369a64
into
OpenZeppelin:changeset-release/release-v5.1
The changelog entry that was automatically generated in #5124 is messy. This proposes to reorganise it following what we did for 5.0