Automate releases to PyPI #267
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
| # This workflow does the following: | |
| # | |
| # - run tests and lint with a variety of Python versions on windows, linux and macos [1] | |
| # - build the tufup package [2] | |
| # - publish to test.pypi.org [2] | |
| # - publish to pypi.org [2] | |
| # | |
| # References | |
| # | |
| # [1]: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python | |
| # [2]: # https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/ | |
| name: Python package | |
| on: | |
| push: | |
| branches: [ master ] | |
| pull_request: | |
| branches: [ master ] | |
| workflow_dispatch: | |
| jobs: | |
| test: | |
| # based on [1] | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: [macos-latest, windows-latest, ubuntu-latest] | |
| # see currently supported releases: https://devguide.python.org/versions/ | |
| python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"] | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install -r requirements.txt | |
| - name: Lint with ruff | |
| run: | | |
| pip install ruff | |
| ruff check --output-format=github . | |
| - name: Test with unittest | |
| run: | | |
| python -m unittest | |
| build: | |
| # based on [2] | |
| needs: test | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.x" | |
| - name: Install pypa/build | |
| run: | | |
| python3 -m pip install build --user | |
| - name: Build a binary wheel and a source tarball | |
| run: python3 -m build | |
| - name: Store the distribution packages | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: python-package-distributions | |
| path: dist/ | |
| publish-to-testpypi: | |
| # note this is done on *every* push, not only tag pushes [2] | |
| needs: [test, build] | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: testpypi | |
| url: https://test.pypi.org/p/tufup | |
| permissions: | |
| id-token: write | |
| steps: | |
| - name: Download the distribution packages | |
| uses: actions/download-artifact@v3 | |
| with: | |
| name: python-package-distributions | |
| path: dist/ | |
| - name: Publish distributions to test.pypi.org | |
| uses: pypa/gh-action-pypi-publish@release/v1 | |
| with: | |
| repository-url: https://test.pypi.org/legacy/ | |
| publish-to-pypi: | |
| # based on [2] | |
| needs: [test, build, publish-to-testpypi] | |
| runs-on: ubuntu-latest | |
| # only publish to pypi on tag pushes (except dev tags) | |
| if: ${{ startsWith(github.ref, 'refs/tags/') && ! contains(github.ref, 'dev') }} | |
| environment: | |
| name: pypi | |
| url: https://pypi.org/p/tufup | |
| permissions: | |
| id-token: write | |
| steps: | |
| - name: temp | |
| run: echo 'nothing yet' |