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

Use towncrier to generate release notes #548

Merged
merged 1 commit into from
Oct 21, 2021

Conversation

terencehonles
Copy link
Contributor

Fixes #535 and superceeds #546

@codecov
Copy link

codecov bot commented Sep 14, 2021

Codecov Report

Merging #548 (4cfc688) into master (dcab2a1) will decrease coverage by 0.5%.
The diff coverage is n/a.

❗ Current head 4cfc688 differs from pull request most recent head aa8664d. Consider uploading reports for the commit aa8664d to get more accurate results
Impacted file tree graph

@@           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             
Flag Coverage Δ
mypy 33.0% <ø> (-0.7%) ⬇️
tests 82.5% <ø> (-0.6%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
django_redis/serializers/pickle.py 89.5% <0.0%> (-10.5%) ⬇️
django_redis/compressors/zstd.py

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update dcab2a1...aa8664d. Read the comment docs.

@@ -142,3 +142,42 @@ jobs:
uses: codecov/codecov-action@v1
with:
flags: mypy

check-changelog:
Copy link
Contributor Author

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
Copy link
Contributor Author

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]
Copy link
Contributor Author

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

Copy link
Member

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

@terencehonles
Copy link
Contributor Author

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 towncrier build will need to be run in order to update the changelog and remove the fragments for release. I'm not sure where we should put that, but maybe it should be part of #512

@WisdomPill
Copy link
Member

you are probably right about #512, maybe @jezdez has something to say about that?

@jezdez
Copy link
Member

jezdez commented Oct 21, 2021

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.

@terencehonles
Copy link
Contributor Author

I added the steps in the file RELEASING.rst. In #512 would be too late since the release would already be tagged, and I contemplated creating another workflow that would create a PR, but that would not be obvious that the workflow existed so I figured I'd just document the steps and we can adjust them in the future if needed.

@terencehonles
Copy link
Contributor Author

I added news fragments for pretty much everything since the last release (anything relevant to put in the change log)

@terencehonles terencehonles merged commit d1f8c2c into jazzband:master Oct 21, 2021
@terencehonles terencehonles deleted the configure-towncrier branch October 21, 2021 23:27
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.

Use towncrier to generate release notes
3 participants