Remove docs dependency on setuptools_scm #989
Conversation
for more information, see https://pre-commit.ci
cidrblock
requested review from
a team,
ssbarnea,
ganeshrn,
priyamsahoo and
relrod
There was a problem hiding this comment.
setuptools-scm is necessary for building from Git checkout. It is by design that it produces unique versions for builds that make it easier to identify the source of a specific build. It should remain in use.
It is also visible @ https://ansible-navigator--989.org.readthedocs.build/en/989/changelog/#v1-1-0-alpha-1-as-of-today-unreleased-draft that this PR breaks both the displayed version and the hardcoded version identifier that became incompatible with PEP 440 (it must be compliant for PyPI uploads not to be rejected and for pip to understand the semantics of the given version).
| # The short X.Y version | ||
| version = ".".join( |
There was a problem hiding this comment.
This is a Sphinx setting. Don't lose it. Although, I'm still against breaking what setuptools-scm provides. If you want to reuse the installed dist metadata, you'd have to (1) integrate setuptools-scm into packaging first and then (2) somehow solve the self-reinstallation on every local build in an optimal way (without tox -r).
| @@ -45,6 +45,8 @@ | |||
| name = "Contributor-facing changes" | |||
| showcontent = true | |||
|
|
|||
| [build-system] | |||
| requires = ["setuptools>=45", "wheel", "setuptools_scm[toml]>=6.2"] | |||
There was a problem hiding this comment.
wheel shouldn't be in this list, setuptools' PEP 517 build backend auto-adds it already.
There was a problem hiding this comment.
(and of course move this to a separate PR as well)
There was a problem hiding this comment.
There's a separate issue for that so don't forget to link it too: #553.
| @@ -95,3 +97,5 @@ skip_glob = ["tests/fixtures/common/collections*"] # Skip ansible content due to | |||
|
|
|||
| [tool.pylint.format] | |||
| max-line-length = 100 | |||
|
|
|||
| [tool.setuptools_scm] | |||
There was a problem hiding this comment.
This whole dist packaging setup refactoring should go into a separate PR as it's not related to docs. It could be accepted separately while the rest of this PR is still in a state that has to be rejected.
There was a problem hiding this comment.
(side note: that separate PR should probably also make use of the write_to setting)
There was a problem hiding this comment.
It can't yet. The _version file contains more than just the package version.
There was a problem hiding this comment.
No, you can do that now. Just don't point it at an existing file. Instead, point it at a gitignored _scm_version.py that you'd import from the _version.py.
Example: https://github.com/sphinx-contrib/sphinxcontrib-towncrier/blob/532e343/pyproject.toml#L16 + https://github.com/sphinx-contrib/sphinxcontrib-towncrier/blob/532e343/src/sphinxcontrib/towncrier/_version.py#L5.
P.S. Also, the same approach is used in ansible-pylibssh.
There was a problem hiding this comment.
Pro tip: create a _scm_version.pyi to take care of typing.
|
This PR is being closed. |
Part of ongoing work to remove
ignore_importsfor mypy.In this case, rather than account for setuptools_scm in the mypy.ini as untyped (pypa/setuptools-scm#501), simply remove the dependency on it entirely.