Skip to content

fix: include kernel-specification.yml in source distribution - #4179

Merged
ianna merged 1 commit into
scikit-hep:mainfrom
5U5H4NTH006:sdist-kernel-specification
Jul 4, 2026
Merged

ianna merged 1 commit into
scikit-hep:mainfrom
5U5H4NTH006:sdist-kernel-specification

Conversation

@5U5H4NTH006

Copy link
Copy Markdown
Contributor

Fixes #4178

tests/test_4056_cuda_compute_signature_consistency.py reads
kernel-specification.yml from the repo root, but that file was not in the
sdist include list in pyproject.toml, so it was absent from the source
distribution. As a result the test errored with FileNotFoundError when the
suite was run against an unpacked sdist (e.g. conda-forge), even though it
passes in a git checkout where the file is present. tests/ already ships in
the sdist, so this just adds the one data file it depends on.

Verification

Built the sdist with python -m build --sdist:

  • Before: tar tzf dist/*.tar.gz | grep kernel-specification.yml returns
    nothing; test_4056 errors with FileNotFoundError when run from the
    unpacked sdist.
  • After: the file is present in the tarball and test_4056 passes against
    the unpacked sdist.

Suggested follow-up (out of scope here)

This slipped through because no CI job runs the test suite against a built
sdist — the main test job runs pytest against the git checkout (where the
file always exists), and reusable-packaging-test.yml builds the sdist but only
runs twine check. Adding a step that unpacks the built sdist and runs the
tests against it would let the existing tests guard against any
missing-from-sdist data file in future, not just this one. Happy to open a
separate PR/issue for that if it's wanted.


AI assistance disclosure:

this change was prepared with the help of an AI
coding assistant (Claude). I reviewed, tested, and understand the change and
take responsibility for it.

…hep#4178)

tests/test_4056_cuda_compute_signature_consistency.py reads
kernel-specification.yml from the repo root, but the file was not part of
the sdist include list, so the test errored with FileNotFoundError when the
suite ran against an unpacked source distribution (e.g. conda-forge). The
tests/ directory already ships, so this adds the one data file it depends on.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@github-actions github-actions Bot added the type/fix PR title type: fix (set automatically) label Jul 3, 2026
@codecov

codecov Bot commented Jul 3, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 83.55%. Comparing base (494a4e5) to head (5f26931).

Additional details and impacted files

@github-actions

github-actions Bot commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

The documentation preview is ready to be viewed at http://preview.awkward-array.org.s3-website.us-east-1.amazonaws.com/PR4179

@ikrommyd ikrommyd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See my comment on the issue #4178 (comment). I think it's a little more messy and we should make it more consistent instead. Needs decision I'd say.

@5U5H4NTH006

Copy link
Copy Markdown
Contributor Author

Got it. I went with the minimal fix since it unblocks the failing test from the sdist. Will update the PR whichever way you and @henryiii decide.

@ianna ianna left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@5U5H4NTH006 — Thank you for your contribution! Indeed we started testing against the “truth” which is the yaml description. Having tests that check against it is a good thing to do! We will need that for the further testing with hypothesis.

@ianna

ianna commented Jul 4, 2026

Copy link
Copy Markdown
Member

@all-contributors please add @5U5H4NTH006 for code

@allcontributors

Copy link
Copy Markdown
Contributor

@ianna

I've put up a pull request to add @5U5H4NTH006! 🎉

@ianna
ianna merged commit 27d5cda into scikit-hep:main Jul 4, 2026
39 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type/fix PR title type: fix (set automatically)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

kernel-specification.yml missing from source distribution

3 participants