-
Notifications
You must be signed in to change notification settings - Fork 40
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Just noticed that recent changes to how setuptools-scm is leveraged has exposed issues with how RTD gets versions. There are two primary issues:
- It is generally considered bad form to get version info at runtime in RTD builds. Best to rely on
importlib.metadata.version
in theconf.py
to get the version determined at install time instead of pulling from__version__.py
which will re-query setuptools-scm if installed (which it is). - The former is a particular issue because RTD only does shallow checkouts of the git repo to save on bandwidth. This means that our tags and release branches aren't present, making it impossible for setuptools-scm to properly determine versions even at build time. Turns out that our use of beta tags on master has hid this problem for latest builds, but it is very evident on the stable side with infers
0.1.0.devNNN
. Fix appears to be configuring RTD to fully checkout the repo.
Unfortunately, I didn't notice this when I was just tweaking all these things, so I'll have to go back and update all components to fix.
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation