-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
Add towncrier README and config #14589
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
Conversation
👍 in principle. |
When I get a little more time this will come with a proper description and email to dev mailing list. |
Please consider moving the config to somewhere else than pyproject.toml (possible per twisted/towncrier#127), as that triggers specific pip behavior that's broken on some setups (pypa/pip#5317). |
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.
One other thing I'll note is that if you don't already have an easily-accessible guide to things like what tense these fragments will be in, whether they should have a period, etc, you should set that up ahead of time just to save everyone time.
I often end up having to correct the tenses or tweak these messages to make them understandable outside the context of the PR, and I always have to go through the old changelogs to figure out what tense / mood these patches are in (Is it "Added X" or "Adds X"...)
* ``api_chage``: A change which requires users to change code and is not | ||
backwards compatible. (Not to be used for removal of deprecated features.) | ||
* ``feature``: New user facing features and any new behavior. | ||
* ``removal``: Removal of a deprecated part of the API. |
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.
It may be worth adding a misc
category here. I find that a pretty significant fraction of my changelog.d
files ends up being something like "changed tox.ini
" or other miscellaneous stuff that isn't user-facing at all.
I currently don't actually have those misc
entries go into the final changelog, but I'm considering putting them in under a <details>
tag or something.
I can chime in to say that we've been doing this on
One last thing to note is that I believe |
I think it would be slightly better to add PEP 517 support for Not sure where the issue for tracking problem 2 is, but if it's a deal-breaker it's probably worth letting the |
I am all ears if you have a better suggestion as to how to better report |
@anntzer I've followed the links, and as far as I can tell this only works when calling |
From https://github.com/hawkowl/towncrier/pull/127/files#diff-8495d47e3a84a0fc5cdb51fd186aafc4R25 you should just be able to call |
As discussed briefly on the call, it'd be nice if this was run during CI (however, that is done) so PR authors can see what this looks like... |
I see you added a test entry. Where does the Changelog get rendered? |
I haven't worked out how to not use |
Perhaps you can manually migrate a couple of currently existing whatsnews to changelog/ to make it easier to test this manually? |
That's not the blocker, I don't think it's possible to have a custom |
Ah, I see. |
So that we do not do all the work double. I have pinged the twisted mailing list about moving along towncrier, I hope that happens fairly soon. If not, I may indeed vendor a patched version into numpy (the pyproject.toml file is currently not my primary concern, but it may still come up and would be nice). |
For reference this is waiting on twisted/towncrier#157 to go in to towncrier |
Closing in favour of #15158 |
This is the start of a PR to do our changelog/what's new using towncrier. More info to follow...