search

sphinx-contrib / sphinxcontrib-towncrier

An RST directive for injecting a Towncrier-generated changelog draft containing fragments for the unreleased (next) project version. Demo: https://ansible-pylibssh.rtfd.io/changelog. Docs: https://sphinxcontrib-towncrier.rtfd.io
https://pypi.org/p/sphinxcontrib-towncrier
BSD 3-Clause "New" or "Revised" License
19 stars 18 forks source link

Dict-access to towncrier's Config objects breaks with Towncrier 22.12 #76

Closed hynek closed 1 year ago

hynek commented 1 year ago

See https://github.com/twisted/towncrier/issues/461 or https://github.com/python-attrs/attrs/actions/runs/3755544183/jobs/6380710259#step:7:39

Config has become a data class in the last release and it's all my fault, sorry.

https://github.com/sphinx-contrib/sphinxcontrib-towncrier/blob/12362b595bfe896e0846072b172dc106cac18349/src/sphinxcontrib/towncrier/ext.py#L132-L143

adiroiban commented 1 year ago

I don't think that for the Towncrier configuration , we made any commitment for a stable API

I can see that this extension uses a towncrier helper that is imported from a private package.

https://github.com/sphinx-contrib/sphinxcontrib-towncrier/blob/12362b595bfe896e0846072b172dc106cac18349/src/sphinxcontrib/towncrier/_towncrier.py#L7-L18

I don't think that we need to worry too much.

This is a developer tool and I hope that nobody is using Towcrier to implement any critical system. By critical system I mean one for which if the latest towncrier breaks, someone will die :)

webknjaz commented 1 year ago

Ack: #75

davfsa commented 1 year ago

@webknjaz would it be possible to make a release soon-ish?

Thank you in advance for getting the bug fixed so quickly!

webknjaz commented 1 year ago

Have fun! https://github.com/sphinx-contrib/sphinxcontrib-towncrier/releases/tag/v0.3.2a0

hynek commented 1 year ago

awesome, thanks!