chore(changelog): Use towncrier to generate release changelogs #1565
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Bencher Report| Branch | chore/towncrier-changelog |
| Testbed | ubuntu-22.04 |
Click to view all benchmark results
| Benchmark | Latency | Benchmark Result minutes (m) (Result Δ%) | Lower Boundary minutes (m) (Limit %) | Upper Boundary minutes (m) (Limit %) |
|---|---|---|---|---|
| sync-v2 (up to 20000 blocks) | 📈 view plot 🚷 view threshold | 1.68 m(-2.23%)Baseline: 1.72 m | 1.55 m (92.05%) | 2.06 m (81.48%) |
msbrogli
force-pushed
the
chore/towncrier-changelog
branch
2 times, most recently
from
4f418de to
b2451d1
Compare
msbrogli
force-pushed
the
chore/towncrier-changelog
branch
from
b2451d1 to
820add9
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
The current release process doesn't have changelogs, making it hard for clients and users to adapt their systems to work correctly with hathor-core. This PR adds changelog fragments using https://towncrier.readthedocs.io/ which will be compiled into release changelogs. It also enforces documenting breaking changes in each PR.
Acceptance Criteria
Checklist
master, confirm this code is production-ready and can be included in future releases as soon as it gets merged