-
-
Notifications
You must be signed in to change notification settings - Fork 428
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
Use towncrier to generate release notes #548
Use towncrier to generate release notes #548
Conversation
Codecov Report
@@ Coverage Diff @@
## master #548 +/- ##
========================================
- Coverage 83.8% 83.4% -0.4%
========================================
Files 21 20 -1
Lines 1175 1157 -18
Branches 60 60
========================================
- Hits 984 964 -20
- Misses 185 187 +2
Partials 6 6
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
@@ -142,3 +142,42 @@ jobs: | |||
uses: codecov/codecov-action@v1 | |||
with: | |||
flags: mypy | |||
|
|||
check-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.
Adds a warning that a changelog entry has not been added to the commit/PR
@@ -1,10 +1,10 @@ | |||
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.
Renamed to CHANGELOG.rst as done in #546 and reformatted to match the changelog output generated by towncrier
@@ -0,0 +1,11 @@ | |||
[tool.towncrier] |
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.
Slimed down the configuration in #546 to use more defaults and used the existing types, but gave them new names
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 am not very familiar with the tool but for me it looks okay.
More complete than the other PR
@WisdomPill we don't have anything that documents the release steps, right? The task |
FWIW I don't have experience with towncrier (although I know a few projects that use it). If you feel comfortable using it, I don't mind if you're generating the changelog this way. It's up to the project leads, really. |
4cfc688
to
27c43ca
Compare
I added the steps in the file |
27c43ca
to
aa8664d
Compare
I added news fragments for pretty much everything since the last release (anything relevant to put in the change log) |
Fixes #535 and superceeds #546