CI #259
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: CI | |
| on: | |
| push: | |
| branches: | |
| - main | |
| tags: | |
| - "v*" | |
| pull_request: | |
| workflow_dispatch: | |
| schedule: | |
| # run every week (for --pre release tests) | |
| - cron: "0 0 * * 0" | |
| # cancel in-progress runs that use the same workflow and branch | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| check-manifest: | |
| # check-manifest is a tool that checks that all files in version control are | |
| # included in the sdist (unless explicitly excluded) | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - run: pipx run check-manifest | |
| test: | |
| name: ${{ matrix.platform }} (${{ matrix.python-version }}) | |
| runs-on: ${{ matrix.platform }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| python-version: ["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@v4 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| cache-dependency-path: "pyproject.toml" | |
| cache: "pip" | |
| - 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@v4 | |
| deploy: | |
| name: Deploy | |
| needs: test | |
| if: success() && startsWith(github.ref, 'refs/tags/') && github.event_name != 'schedule' | |
| 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 | |
| - name: 🐍 Set up Python | |
| uses: actions/setup-python@v5 | |
| 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 | |
| with: | |
| password: ${{ secrets.TWINE_API_KEY }} | |
| - uses: softprops/action-gh-release@v1 | |
| with: | |
| generate_release_notes: true | |
| files: './dist/*' |