Fix tarball and wheel #295
Conversation
ocefpaf
requested review from
malmans2,
renskegelderloos,
ThomasHaine,
MaceKuailv,
asiddi24 and
Mikejmnez
as code owners
|
|
||
| distribution: | ||
| runs-on: ubuntu-latest | ||
| needs: [pytest] | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| - name: Build distributions | ||
| run: | | ||
| $CONDA/bin/python -m pip install build | ||
| $CONDA/bin/python -m build | ||
| - name: Publish a Python distribution to PyPI | ||
| if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags') | ||
| uses: pypa/gh-action-pypi-publish@release/v1 | ||
| with: | ||
| user: __token__ | ||
| password: ${{ secrets.PYPI_API_TOKEN }} |
There was a problem hiding this comment.
@malmans2 let me know if this is OK. I factor it out so we can include sdist and wheels only tests in a new GHA.
| run: | | ||
| cd dist && python -m pip install oceanspy*.whl | ||
| python -m twine check * | ||
| python -c "import oceanspy; print(f'oceanspy v{oceanspy.__version__}')" |
There was a problem hiding this comment.
We can add more tests here, even run the full test suite, but for now importing is enough b/c it already shows the problem and that it is fixed by this PR.
| @@ -1,11 +1,15 @@ | |||
| include AUTHORS.rst | |||
There was a problem hiding this comment.
Is there a particular reason behind removing this?
There was a problem hiding this comment.
This file doesn't exist. Maybe I'm missing something but a manifest check could not find it.
| prune assets | ||
| prune docs | ||
| prune binder | ||
| prune paper | ||
| prune sciserver_catalogs/ | ||
| prune *.egg-info |
There was a problem hiding this comment.
This should reduce the tarball from ~6MB to 881K.
| @@ -36,7 +36,7 @@ testpaths = ["oceanspy/tests"] | |||
| addopts = "-v --cov" | |||
|
|
|||
| [tool.setuptools] | |||
| py-modules = ["oceanspy"] | |||
| packages = ["oceanspy"] | |||
There was a problem hiding this comment.
This is the only part of this PR that is "really" needed to fix the issue.
Codecov Report
@@ Coverage Diff @@
## main #295 +/- ##
=======================================
Coverage 95.25% 95.25%
=======================================
Files 9 9
Lines 3898 3898
Branches 833 833
=======================================
Hits 3713 3713
Misses 116 116
Partials 69 69
Flags with carried forward coverage won't be shown. Click here to find out more. 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
|
Thank you @ocefpaf ! I don't fully understand why the docs didn't build, but once they do we can merge this PR. |
I don't use readthedocs so I'm clueless on what can I do here to fix it. Their error message seems to be a red herring b/c I can clone the PR using that command. |
Yeah, I agree it's a weird error. I can also clone the repository with the failing command. I'll approve this PR and if there is an issue later with the documentation, we can always fix it afterwards. I really want to get the new version of oceanspy released |
|
Thanks @ocefpaf! |
Closes #294
CI from before the fix: https://github.com/ocefpaf/oceanspy/actions/runs/3688029568/jobs/6242344958#step:8:74
And after the fix: https://github.com/ocefpaf/oceanspy/actions/runs/3688196116/jobs/6242710952#step:8:71
The wheel is now installable and importable.