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
18 stars 18 forks source link

Adjust the config loader import to support `towncrier >= 22.8.0rc1` #61

Closed ericpre closed 2 years ago

ericpre commented 2 years ago

This patch implements compatibility with the newly released towncrier >= 22.8.0rc1. Since the extension relies on the Towncrier's private API, this sort of thing is bound to happen time to time. It is solved by using a fallback import logic.

This change also adds the said Towncrier version to the CI matrix.

Fixes #60.

ericpre commented 2 years ago

@webknjaz, does this PR look good to you? Thanks! :)

webknjaz commented 2 years ago

It seems fine but I don't like reviewing from phone because I may miss the bigger picture so I'll probably get to it tomorrow when I have access to my laptop. I won't be cutting a release from phone anyway. Plus, the next release will likely wait for the other two open PRs to be complete first. One improvement that seems necessary is adding this new release to the GHA matrix so that it's visible they it works as expected.

ericpre commented 2 years ago

Thank you for the quick follow up - this sounds good to me!

ericpre commented 2 years ago

Thank you!

webknjaz commented 2 years ago

This has been released in v0.3.0a0: https://pypi.org/project/sphinxcontrib-towncrier/0.3.0a0/.