restore full test suite to sdist #725
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
adrienverge
added a commit
that referenced
this pull request
Mar 17, 2025
This commit fixes a problem reported by Nicholas Bollweg at #725. Recent commit a3e1325 "CI: Publish PyPI releases using GitHub Actions workflows" and automatic publication of version 1.36.1 revealed a problem that had probably been there for some time: most documentation and test files weren't included in the source distribution when running `python -m build` (unless an `yamllint.egg-info` from a previous run listed them). I see two solutions: 1. Add plugin `setuptools-scm` in `pyproject.toml`: requires = ["setuptools >= 61", "setuptools-scm >= 8"] This would add all files tracked by Git in the sdist, including a few unneeded for sdist: `.flake8`, `.github`, `.readthedocs.yaml`… 2. Declare extra files to embed in `MANIFEST.in`. This is what this commit does. I checked that: - All files packages before 1.36.0 are correctly included now: tar -tvf dist/yamllint-1.36.0.tar.gz | cut -b65- \ > /tmp/sdist-files-before rm -rf yamllint.egg-info && python -m build && \ tar -tvf dist/yamllint-1.36.1.tar.gz | cut -b65- \ > /tmp/sdist-files-after git diff --no-index /tmp/sdist-files-before /tmp/sdist-files-after - These extra files are still not installed by `pip install` (they are not needed): pip install yamllint==1.36.0 && \ tree ~/.local/lib/python3.13/site-packages/yamllint \ > /tmp/pip-install-before pip install dist/yamllint-1.36.1.tar.gz && \ tree ~/.local/lib/python3.13/site-packages/yamllint \ > /tmp/pip-install-after git diff --no-index /tmp/pip-install-before /tmp/pip-install-after
adrienverge
added a commit
that referenced
this pull request
Mar 17, 2025
This commit fixes a problem reported by Nicholas Bollweg at #725. Recent commit a3e1325 "CI: Publish PyPI releases using GitHub Actions workflows" and automatic publication of version 1.36.1 revealed a problem that had probably been there for some time: most documentation and test files weren't included in the source distribution when running `python -m build` (unless an `yamllint.egg-info` from a previous run listed them). I see two solutions: 1. Add plugin `setuptools-scm` in `pyproject.toml`: requires = ["setuptools >= 61", "setuptools-scm >= 8"] This would add all files tracked by Git in the sdist, including a few that aren't really needed: `.flake8`, `.github`, `.readthedocs.yaml`… 2. Declare extra files to embed in `MANIFEST.in`. This is what this commit does. I checked that: - All files packages before 1.36.0 are correctly included now: tar -tvf dist/yamllint-1.36.0.tar.gz | cut -b65- \ > /tmp/sdist-files-before rm -rf yamllint.egg-info && python -m build && \ tar -tvf dist/yamllint-1.36.1.tar.gz | cut -b65- \ > /tmp/sdist-files-after git diff --no-index /tmp/sdist-files-before /tmp/sdist-files-after - These extra files are still not installed by `pip install` (they are not needed): pip install yamllint==1.36.0 && \ tree ~/.local/lib/python3.13/site-packages/yamllint \ > /tmp/pip-install-before pip install dist/yamllint-1.36.1.tar.gz && \ tree ~/.local/lib/python3.13/site-packages/yamllint \ > /tmp/pip-install-after git diff --no-index /tmp/pip-install-before /tmp/pip-install-after
Owner
|
Hello Nicholas, Thanks for the report! Indeed this needs fixing. The present PR does not fully resolve the problem, because other files (e.g. documentation in So I implemented #726 instead. Can you confirm it solves the problem on your side? |
adrienverge
added a commit
that referenced
this pull request
Mar 17, 2025
This commit fixes a problem reported by Nicholas Bollweg at #725. Recent commit a3e1325 "CI: Publish PyPI releases using GitHub Actions workflows" and automatic publication of version 1.36.1 revealed a problem that had probably been there for some time: most documentation and test files weren't included in the source distribution when running `python -m build` (unless an `yamllint.egg-info` from a previous run listed them). I see two solutions: 1. Add plugin `setuptools-scm` in `pyproject.toml`: requires = ["setuptools >= 61", "setuptools-scm >= 8"] This would add all files tracked by Git in the sdist, including a few that aren't really needed: `.flake8`, `.github`, `.readthedocs.yaml`… 2. Declare extra files to embed in `MANIFEST.in`. This is what this commit does. I checked that: - All files packages before 1.36.0 are correctly included now: tar -tvf dist/yamllint-1.36.0.tar.gz | cut -b65- \ > /tmp/sdist-files-before rm -rf yamllint.egg-info && python -m build && \ tar -tvf dist/yamllint-1.36.1.tar.gz | cut -b65- \ > /tmp/sdist-files-after git diff --no-index /tmp/sdist-files-before /tmp/sdist-files-after - These extra files are still not installed by `pip install` (they are not needed): pip install yamllint==1.36.0 && \ tree ~/.local/lib/python3.13/site-packages/yamllint \ > /tmp/pip-install-before pip install dist/yamllint-1.36.1.tar.gz && \ tree ~/.local/lib/python3.13/site-packages/yamllint \ > /tmp/pip-install-after git diff --no-index /tmp/pip-install-before /tmp/pip-install-after
Author
|
Sure, explicit is better than implicit! Just shipped the (tested) Frankly the best way to ensure this kind of thing is to have a CI excursion that does the equivalent of what a downstream would do:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Congratulations on 1.36.1, and as always thank you for maintaining this tool!
Downstream we noted that the
testsfolder is incomplete, failing to import withtests.commonbeing missing. We shipped just getting those files from the GitHub-generated tarball, but it is generally to convenient to have a single canonical, immutable file (and SHA) to track.I don't think
sdist-only files can be added directly inpyproject.tomlwith thesetuptoolslegacy backend, so this PR adds a one-linerMANIFEST.into preserve all the files intestsin the sdist.Thanks again!