Build with hatch and tags for versioning #15
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 workflows will upload a Python Package using Twine when a release is created | |
| # For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries | |
| name: tests | |
| on: | |
| push: | |
| branches: | |
| - main | |
| tags: | |
| - "v*" # Push events to matching v*, i.e. v1.0, v20.15.10 | |
| pull_request: | |
| branches: | |
| - main | |
| workflow_dispatch: | |
| jobs: | |
| test: | |
| name: ${{ matrix.platform }} (${{ matrix.python-version }}) | |
| runs-on: ${{ matrix.platform }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| python-version: ["3.8", "3.9", "3.10", "3.11"] | |
| platform: [ubuntu-latest, macos-latest, windows-latest] | |
| steps: | |
| - name: 🛑 Cancel Previous Runs | |
| uses: styfle/[email protected] | |
| with: | |
| access_token: ${{ github.token }} | |
| - uses: actions/checkout@v3 | |
| - name: 🐍 Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install Dependencies | |
| run: | | |
| python -m pip install -U pip | |
| # if running a cron job, we add the --pre flag to test against pre-releases | |
| python -m pip install .[test] ${{ github.event_name == 'schedule' && '--pre' || '' }} | |
| - name: 🧪 Run Tests | |
| run: pytest --color=yes --cov --cov-report=xml --cov-report=term-missing | |
| # If something goes wrong with --pre tests, we can open an issue in the repo | |
| - name: 📝 Report --pre Failures | |
| if: failure() && github.event_name == 'schedule' | |
| uses: JasonEtco/create-an-issue@v2 | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| PLATFORM: ${{ matrix.platform }} | |
| PYTHON: ${{ matrix.python-version }} | |
| RUN_ID: ${{ github.run_id }} | |
| TITLE: "[test-bot] pip install --pre is failing" | |
| with: | |
| filename: .github/TEST_FAIL_TEMPLATE.md | |
| update_existing: true | |
| - name: Coverage | |
| uses: codecov/codecov-action@v3 | |
| deploy: | |
| name: Deploy | |
| needs: test | |
| if: success() && startsWith(github.ref, 'refs/tags/') | |
| runs-on: ubuntu-latest | |
| permissions: | |
| # IMPORTANT: this permission is mandatory for trusted publishing on PyPi | |
| # see https://docs.pypi.org/trusted-publishers/ | |
| id-token: write | |
| # This permission allows writing releases | |
| contents: write | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: 🐍 Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: 3.x | |
| - name: 👷 Build | |
| run: | | |
| python -m pip install build | |
| python -m build | |
| - name: 🚢 Publish to PyPI | |
| uses: pypa/gh-action-pypi-publish@release/v1 | |
| - uses: softprops/action-gh-release@v1 | |
| with: | |
| generate_release_notes: true | |
| files: ./dist/* |