Publish to PyPI #34
This file contains 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
# Publish archives to PyPI and TestPyPI using GitHub Actions | |
name: Publish to PyPI | |
on: [workflow_dispatch] | |
jobs: | |
build-artifact: | |
name: Build echoregions package | |
runs-on: ubuntu-20.04 | |
if: github.repository == 'OSOceanAcoustics/echoregions' | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v4 | |
with: | |
# fetch all history so that setuptools-scm works | |
fetch-depth: 0 | |
- name: Set up Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: 3.9 | |
- name: Install dependencies | |
run: python -m pip install setuptools wheel | |
# This step is only necessary for testing purposes and for TestPyPI | |
- name: Fix up version string for TestPyPI | |
if: ${{ !startsWith(github.ref, 'refs/tags') }} | |
run: | | |
# Change setuptools-scm local_scheme to "no-local-version" so the | |
# local part of the version isn't included, making the version string | |
# compatible with PyPI. | |
sed --in-place "s/node-and-date/no-local-version/g" pyproject.toml | |
- name: Build source and wheel distributions | |
run: | | |
python setup.py sdist bdist_wheel | |
echo "" | |
echo "Generated files:" | |
ls -lh dist/ | |
- uses: actions/upload-artifact@v4 | |
with: | |
name: releases | |
path: dist | |
test-built-dist: | |
name: Test echoregions package | |
needs: build-artifact | |
runs-on: ubuntu-20.04 | |
permissions: | |
contents: read | |
id-token: write | |
steps: | |
- uses: actions/setup-python@v5 | |
name: Install Python | |
with: | |
python-version: 3.9 | |
- uses: actions/download-artifact@v4 | |
with: | |
name: releases | |
path: dist | |
- name: List contents of built dist | |
run: | | |
ls -ltrh | |
ls -ltrh dist | |
- name: Publish to Test PyPI | |
uses: pypa/[email protected] | |
with: | |
repository-url: https://test.pypi.org/legacy/ | |
verbose: true | |
skip-existing: true | |
- name: Check pypi packages | |
run: | | |
sleep 3 | |
python -m pip install --upgrade pip | |
echo "=== Testing wheel file ===" | |
# Install wheel to get dependencies and check import | |
python -m pip install --extra-index-url https://test.pypi.org/simple --upgrade --pre echoregions | |
python -c "import echoregions;" | |
echo "=== Done testing wheel file ===" | |
echo "=== Testing source tar file ===" | |
# Install tar gz and check import | |
python -m pip uninstall --yes echoregions | |
python -m pip install --extra-index-url https://test.pypi.org/simple --upgrade --pre --no-binary=:all: echoregions | |
python -c "import echoregions;" | |
echo "=== Done testing source tar file ===" | |
publish-pypi: | |
name: Push echoregions to production pypi | |
needs: test-built-dist | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/download-artifact@v4 | |
with: | |
name: releases | |
path: dist | |
- name: Publish to PyPI | |
uses: pypa/[email protected] |