Include linked assets in source distribution - #44
Merged
Merged
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Includes the documentation and reproducibility assets referenced by files in the source distribution.
Why
PR #43 added
MANIFEST.inso source distributions retain the repository documentation and example materials. However, the original patterns included only:This omitted files that the included documentation depends on, including:
docs/figures/, such ascover.png;examples/run_manifest_template.yml;regenerate.py;expected_tree.txt.As a result, an unpacked source distribution could contain documentation with broken links or incomplete reproducibility instructions even though the files are present in the GitHub repository.
Changes
docs/source-distribution pattern to include:examples/source-distribution pattern to include:The resulting manifest patterns are:
Validation
python -m py_compile tests/test_project_metadata.py python -m pytest tests/test_project_metadata.py python -m pytest python -m pre_commit run --all-files rm -rf build dist python -m build python -m twine check dist/*The source distribution should also be inspected to confirm that the linked assets are present, including:
and any reproducibility example files such as:
Compatibility
0.6.5;Scope
This is a packaging-only correction following the review of PR #43. It does not create a release, publish to PyPI or Zenodo, or change numerical behaviour.