Website changelog does not reflect CHANGELOG.md

[joshy]

Problem

The latest changelog entry on the website https://voila.readthedocs.io/en/stable/changelog.html is 0.5.1 but now 0.5.8 is already released: https://github.com/voila-dashboards/voila/blob/main/CHANGELOG.md

Suggested Improvement

Maybe it is possible to update the website with each release or the website could always render CHANGELOG.md?

[martinRenou]

Thanks for opening an issue, looking into it!

[jtpio]

It's probably because there is a stable branch on the repo? https://github.com/voila-dashboards/voila/tree/stable

[martinRenou]

Yes, I updated the stable branch, it built and passed! Thanks https://voila.readthedocs.io/en/stable/

[jtpio]

Normally the stable branch is reset after each release.

Maybe it's related to the switch to releaser v2, which does not take into account this hook:

voila/pyproject.toml

Line 184 in 3a57e7a

after-draft-release = "bash ./scripts/reset-stable.sh"

[jtpio]

Reopening so we should update that hook so the branch keeps being updated.

[jtpio]

An alternative would be to remove that stable branch, since RTD should manage stable versions automatically?

[martinRenou]

should manage stable versions automatically?

Does it? I understand that by default "latest" is the latest commit?

[jtpio]

From https://docs.readthedocs.io/en/stable/versions.html:

If your project has any tags or branches with a name following semantic versioning, we also create a stable version tracking your most recent release. If you want a custom stable version, create either a tag or branch in your project with that name.