Add GH-Action-based CI #5
Conversation
|
This does still upload the wheels, but I can take that out pretty easily. I'm wrapping up for the day, but I plan to toy with this more on the weekend. Should I remove the "upload wheels" part? Either way, I'll look to get started on implementing |
|
|
||
| - run: python -m pip install build | ||
|
|
||
| - run: python -m build . |
There was a problem hiding this comment.
| - run: python -m build . | |
| - run: python -m build --wheel |
(. optional)
You are already building the SDist above, so no need to repeat it here.
There was a problem hiding this comment.
Though admittedly, you only upload the wheel in the next line, and build will make the SDist and then build the wheel from it rather than directly making the wheel, so this might not be a good suggestion to take. If you had broken SDists your version would catch it, and mine wouldn't.
There was a problem hiding this comment.
Just a warning (you did it correctly here, but in case it ever matters), GitHub Actions will actually corrupt the binaries if you download several artifacts with any matching files. It's an annoying bug, as you have to make sure not to upload SDists from more than one job or wheels that match.
Very annoying bug to track down. ;)
.github/workflows/main.yml
Outdated
| make_sdist: | ||
| name: Make SDist | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
|
|
||
| - uses: actions/setup-python@v5 | ||
| with: | ||
| python-version: "3.12" | ||
|
|
||
| - run: python -m pip install build | ||
|
|
||
| - run: python -m build . | ||
|
|
||
| - name: Upload SDist | ||
| uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: example | ||
| path: dist/*.tar.gz | ||
|
|
||
| build_wheels: | ||
| name: Wheel on ${{ matrix.os }} | ||
| runs-on: ${{ matrix.os }} | ||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| os: [ubuntu-latest, windows-latest, macos-latest] | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
|
|
||
| - uses: actions/setup-python@v5 | ||
| with: | ||
| python-version: "3.12" | ||
|
|
||
| - run: python -m pip install build | ||
|
|
||
| - run: python -m build . | ||
|
|
||
| - name: Upload Wheels | ||
| uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: example-wheel-${{ matrix.os }} | ||
| path: dist/*.whl |
There was a problem hiding this comment.
These can be combined into a single job and then you can just have a condition if statement on the upload of the sdist that checks to see if the OS is ubuntu-latest and if so then uploads the sdist.
There was a problem hiding this comment.
Multiple jobs matches the future structure better, though. For a pure Python job you'd just have one ubuntu job that builds the wheel and SDist, and one upload. But for binaries you usually split it out rather than trying to just pick one to make the SDist on.
There was a problem hiding this comment.
So... should I combine them into one job? Or leave it as is?
There was a problem hiding this comment.
Keeping them as 2 jobs is fine.
…low_dispath Co-authored-by: Matthew Feickert <matthew.feickert@cern.ch>
Co-authored-by: Henry Schreiner <HenrySchreinerIII@gmail.com>
j-s-ashley
force-pushed
the
add_GHA_based_CI
branch
from
f063862
to
f6760e1
Compare
This is the implementation using
python -m build .. Resolves Issue #3.