Skip to content

RTD build issues with setuptools_scm #97

@dihm

Description

@dihm

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 the conf.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 documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

    pFad - Phonifier reborn

    Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

    Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


    Alternative Proxies:

    Alternative Proxy

    pFad Proxy

    pFad v3 Proxy

    pFad v4 Proxy