tenacity icon indicating copy to clipboard operation
tenacity copied to clipboard

Changelog is missing entry for version 8.1.0

Open tdwright opened this issue 2 years ago • 5 comments

At the time of writing, 8.1.0 is the latest version. It was released on September 21st. Github tags and PyPI agree.

Unfortunately the changelog is still showing the prior version (8.0.1) as the latest. It does not contain any reference to 8.1.0.

For those of us who are gratefully using this excellent package and want to stay up-to-date, having the details of the latest changes documented is a great help.

tdwright avatar Nov 02 '22 19:11 tdwright

Today a very similar observation applies, the latest release is 8.2.0 on PyPI and GitHub tags; the last release listed on https://tenacity.readthedocs.io/en/latest/changelog.html is 8.1.0

Thank you for providing this library

maxwell-k avatar Feb 08 '23 10:02 maxwell-k

The changelog is currently only available up to 8.2.2, but the latest release is 9.0. I think it would be particularly useful for the breaking change to be included in the log (in fact, I came here looking to see what I need to account for in order to start using 9.0).

Is there some manual step that needs to be taken during release, to update the changelog, and that typically isn't happening?

steve-mavens avatar Jul 30 '24 10:07 steve-mavens

I suspect this is a build problem with readthedocs; when a git tag is pushed, the build is not done again on RTD so it has no clue that 9.0.0 is out.

Wondering if it's not better at this stage to link to https://github.com/jd/tenacity/releases

jd avatar Jul 30 '24 13:07 jd

Certainly it would be useful if the RTD changelog page had a link at the top saying where to find the changelogs post 8.2.2. Are all of the docs on RTD out of date, or just the changelog page? If they all are then I'd suggest it's worth either keeping them updated somehow (even if that means manually logging into RTD and triggering the rebuild after each release), or taking them down entirely.

steve-mavens avatar Jul 30 '24 13:07 steve-mavens

I haven't used it myself yet, but I think github might be a viable alternative to RTD these days: run Sphinx through github actions and link to the resulting html from the README. Please don't hate me if I'm wrong, and there's lots of annoying problems once you get into the details of that process :-)

steve-mavens avatar Jul 30 '24 13:07 steve-mavens