Add release workflow #1
Workflow file for this run
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
| name: Build and Upload carbonplan_data to PyPI | |
| on: | |
| release: | |
| types: | |
| - published | |
| # Runs for pull requests should be disabled other than for testing purposes | |
| pull_request: | |
| branches: | |
| - main | |
| permissions: | |
| contents: read | |
| jobs: | |
| build-artifacts: | |
| runs-on: ubuntu-latest | |
| if: github.repository == 'carbonplan/data' | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - uses: actions/setup-python@v5.0.0 | |
| name: Install Python | |
| with: | |
| python-version: 3.11 | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| python -m pip install build twine | |
| # 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 tarball and wheels | |
| run: | | |
| git clean -xdf | |
| git restore -SW . | |
| python -m build | |
| - name: Check built artifacts | |
| run: | | |
| python -m twine check --strict dist/* | |
| pwd | |
| if [ -f dist/carbonplan_data-0.0.0.tar.gz ]; then | |
| echo "❌ INVALID VERSION NUMBER" | |
| exit 1 | |
| else | |
| echo "✅ Looks good" | |
| fi | |
| - uses: actions/upload-artifact@v4 | |
| with: | |
| name: releases | |
| path: dist | |
| test-built-dist: | |
| needs: build-artifacts | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/setup-python@v5.0.0 | |
| name: Install Python | |
| with: | |
| python-version: 3.10 | |
| - uses: actions/download-artifact@v4 | |
| with: | |
| name: releases | |
| path: dist | |
| - name: List contents of built dist | |
| run: | | |
| ls -ltrh | |
| ls -ltrh dist | |
| - name: Verify the built dist/wheel is valid | |
| run: | | |
| python -m pip install --upgrade pip | |
| python -m pip install dist/carbonplan_data*.whl | |
| python -c "from carbonplan_data.utils import get_versions; print(get_versions())" | |
| - name: Publish package to TestPyPI | |
| uses: pypa/gh-action-pypi-publish@v1.8.14 | |
| with: | |
| password: ${{ secrets.TEST_PYPI_TOKEN }} | |
| repository-url: https://test.pypi.org/legacy/ | |
| # verbose: true | |
| upload-to-pypi: | |
| needs: test-built-dist | |
| if: github.event_name == 'release' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/download-artifact@v4 | |
| with: | |
| name: releases | |
| path: dist | |
| - name: Publish package to PyPI | |
| uses: pypa/gh-action-pypi-publish@v1.8.14 | |
| with: | |
| password: ${{ secrets.PYPI_TOKEN }} | |
| # verbose: true |