Repository navigation
ENH: use towncrier to build the release note - #13908
Conversation
|
I am wondering if we can do a tiny CI check to avoid bad file naming? |
There was a problem hiding this comment.
Might be a bit cryptic without information on where to look?
There was a problem hiding this comment.
adding the path to the README.rst
shoyer
left a comment
shoyer
left a comment
There was a problem hiding this comment.
This should definitely make for a better contributor workflow :)
There was a problem hiding this comment.
I don't think this is true for our template, so this should probably be removed -- you removed the automatic insertion of list items from the pytest template.
|
It seems towncrier requires a |
There was a problem hiding this comment.
When using pyproject.yaml, setup.py is now called via exec(compile(code, __file__, 'exec'), locals()) in python pip/_vendor/pep517/_in_process.py get_requires_for_build_wheel /tmp/tmp6g6mz9bq. Since it is not called directly on the command line in a subprocess but via exec, sys.argv[0] is no longer ./setup.py.
There was a problem hiding this comment.
yeah, just tracked down this too, but did not manage to quite get to the bottom of everything, maybe we can fix it tomorrow, or push towncrier to give an alternative toml file... (I commented on an issue there)
There was a problem hiding this comment.
This change looks harmless to me - functions in setup.py aren't public API, and any use-case involving symlinks to setup.py seems incredibly contrived
There was a problem hiding this comment.
It's tempting to do the PEP 508 stuff in a separate PR, just to give it a little more visibility. This looks harmless, but it might be good to seed discussion about any further PEP508 changes
|
Adding the pyproject.toml file seemed non-controversial on the mailing list. Can this go in as-is? |
|
I have opened twisted/towncrier#156 which adds |
|
When #14053 goes in this will need a rebase |
|
OK, rebased and squashed this. Will likely merge soon. |
|
OK, I will merge this. happy to revert and clean up everything if someone is unhappy with that (sorry in that case). But there are a few PRs that I would like to get going, and they need release notes, so being unclear about how to write them best right now is not helpful. (EDIT: last push only removed bogus blank line from setup.py) |
|
Ok, I noticed that there is at least one typo and the final release notes are indented a bit funnily (template issue probably). These are small things and I will probably create a quick update PR soon. |
|
Hmmm, I am a bit disappointed. It seems to me that towncrier expects release notes to always come in a bullet point format. But we often have longer text and currently use a subheading format. And right now, I think I would prefer to keep it like that. I think I will look into pushing some fixes for that upstream... Does not need to stop us using it for the moment though, at least we cannot possibly run into issues with merge conflicts... |
Add infrastructure and instructions to use towncrier to build the release note from a directory of fragments.
python -mtowncrier --draft(once there are some fragments in./changelog) will preview the current release note status.Running
python -mtowncrierwill overwrite./doc/release/latest-note.rst, delete all the fragments from./changelog, and stage the changes for a git commit.A fragment is a file in
./changelogwith a name like139999.changes.rstwith a title line and content like