You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Currently if you want to check the validity of any newsfragment locally you need to do something like
export READTHEDOCS=1
cd docs
make html
but then towncrier will attempt to remove your newsfragments as well as update changelog.rst, which means you need to afterwards restore/unstage the changes to those files.
It would be great to have an invocation of a shell script/tox/hatch/make target/etc that checked the formatting of the fragments without messing up local files.
The text was updated successfully, but these errors were encountered:
Hmm, currently towncrier only runs if READTHEDOCS is set. What we could do instead is use --keep so it doesn't remove the newsfragments - we only really want that when committing a release. Have the sphinx conf.py first read in the changelog file, run towncrier, then revert the file after the build finished.
Currently if you want to check the validity of any newsfragment locally you need to do something like
but then towncrier will attempt to remove your newsfragments as well as update
changelog.rst
, which means you need to afterwards restore/unstage the changes to those files.It would be great to have an invocation of a shell script/tox/hatch/make target/etc that checked the formatting of the fragments without messing up local files.
The text was updated successfully, but these errors were encountered: