Update towncrier settings #1626
Conversation
Codecov Report
@@ Coverage Diff @@
## main #1626 +/- ##
=======================================
Coverage 97.21% 97.21%
=======================================
Files 83 83
Lines 7961 7961
=======================================
Hits 7739 7739
Misses 222 222 Continue to review full report at Codecov.
|
|
We'll need to test this after #1623 is merged to make sure it works. |
| filename = "CHANGELOG.rst" | ||
| directory = "changelog/" | ||
| issue_format = "`#{issue} <https://github.com/plasmapy/plasmapy/pull/{issue}>`__" | ||
| issue_format = ":issue:`{issue}`" | ||
| wrap = true |
There was a problem hiding this comment.
I still don't know what wrap is. What is this? I don't see it anywhere in the towncrier documentation.
There was a problem hiding this comment.
It's to wrap the output to 79 characters, from their further options
There was a problem hiding this comment.
Ok...their documentation really sucks!!!!
Have you double checked that this option is available in the current release? That did already bite us once in the butt.
There was a problem hiding this comment.
It was added 4 years ago according to the git blame, so we should be okay.
|
@rocco8773, I also made the changelog a tad more prominent in the sidebar. |
pyproject.toml
Outdated
| package = "plasmapy" | ||
| name = "PlasmaPy" | ||
| filename = "CHANGELOG.rst" | ||
| directory = "changelog/" | ||
| issue_format = "`#{issue} <https://github.com/plasmapy/plasmapy/pull/{issue}>`__" | ||
| issue_format = ":issue:`{issue}`" | ||
| wrap = true |
There was a problem hiding this comment.
Do you want to add back the title_format key so the changelog titles have the version v and look like PlasmaPy v0.8.2.dev... instead of PlasmaPy 0.8.2.dev...?
There was a problem hiding this comment.
Good call! I missed that the v was missing.
|
Once I confirm the title looks good on the new build, I'll slap an approve onto this. |
This is an experiment to change a few towncrier and see if they work with their latest release.
This is a small subset of the changes we tried in #1623 (see this comment).