Improve github action for checks #130
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: CI | ||
| on: | ||
| push: | ||
| branches: [main] | ||
| pull_request: {} | ||
| concurrency: | ||
| group: ${{ github.workflow }}-${{ github.ref }} | ||
| cancel-in-progress: true | ||
| jobs: | ||
| check-manifest: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - run: pipx run check-manifest | ||
| pre-commit: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - uses: actions/setup-python@v5 | ||
| with: | ||
| python-version-file: .python-version-default | ||
| - uses: pre-commit/action@v3.0.1 | ||
| install-dev: | ||
| name: Verify dev env | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - uses: actions/setup-python@v5 | ||
| with: | ||
| python-version-file: .python-version-default | ||
| cache: pip | ||
| - name: Install in dev mode & import | ||
| run: | | ||
| python -Im pip install -e .[dev] | ||
| python -Ic 'import subliminal; print(subliminal.__version__)' | ||
| typing: | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| contents: read | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - uses: actions/setup-python@v5 | ||
| with: | ||
| python-version-file: .python-version-default | ||
| - name: Install tox-uv | ||
| run: python -Im pip install tox-uv | ||
| - name: type-check | ||
| run: python -Im tox run -e mypy | ||
| docs: | ||
| name: Build docs and run doctests | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - uses: actions/setup-python@v5 | ||
| with: | ||
| # Keep in sync with tox/docs and .readthedocs.yaml. | ||
| python-version: "3.12" | ||
| cache: pip | ||
| - name: Install tox-uv | ||
| run: python -Im pip install tox-uv | ||
| - name: Build docs | ||
| run: python -Im tox run -e docs,changelog | ||
| - uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: docs | ||
| path: docs/_build/ | ||
| build-package: | ||
| name: Build & verify package | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| with: | ||
| fetch-depth: 0 | ||
| - uses: hynek/build-and-inspect-python-package@v2 | ||
| id: baipp | ||
| outputs: | ||
| # Used to define the matrix for tests below. The value is based on | ||
| # packaging metadata (trove classifiers). | ||
| supported-python-versions: ${{ steps.baipp.outputs.supported_python_classifiers_json_array }} | ||
| test: | ||
| name: Test | ||
| runs-on: ${{ matrix.os }} | ||
| needs: build-package | ||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| os: [ubuntu-latest, macos-latest, windows-latest] | ||
| # Created by the build-and-inspect-python-package action above. | ||
| python-version: ${{ fromJson(needs.build-package.outputs.supported-python-versions) }} | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - uses: actions/setup-python@v5 | ||
| with: | ||
| python-version: ${{ matrix.python-version }} | ||
| cache: 'pip' | ||
| allow-prereleases: true | ||
| - name: Install tox-uv | ||
| run: python -Im pip install tox-uv | ||
| - name: install | ||
| run: python -Im pip install -e .[test] | ||
| - uses: hynek/setup-cached-uv@v2 | ||
| - name: Prepare tox | ||
| run: | | ||
| echo TOX_PYTHON=py$(echo ${{ matrix.python-version }} | tr -d .) >>$GITHUB_ENV | ||
| - run: >- | ||
|
Check failure on line 124 in .github/workflows/check.yaml
|
||
| uvx --with=tox-uv | ||
| tox run | ||
| -e py${{ TOX_PYTHON }}-coverage | ||
| env: | ||
| COVERAGE_FILE: ".coverage.${{ matrix.os }}.${{ matrix.python-version }}" | ||
| # Alternatively you can run coverage with the --parallel flag or add | ||
| # `parallel = True` in the coverage config file. | ||
| # If using pytest-cov, you can also add the `--cov-append` flag | ||
| # directly or through PYTEST_ADD_OPTS. | ||
| - name: Store coverage file | ||
| uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: coverage-${{ matrix.os }}-${{ matrix.python-version }} | ||
| path: .coverage.${{ matrix.os }}.${{ matrix.python-version }} | ||
| coverage: | ||
| name: Coverage | ||
| runs-on: ubuntu-latest | ||
| needs: test | ||
| permissions: | ||
| pull-requests: write | ||
| contents: write | ||
| steps: | ||
| - name: Download pre-built packages | ||
| uses: actions/download-artifact@v4 | ||
| with: | ||
| name: Packages | ||
| path: dist | ||
| - run: tar -xf dist/*.tar.gz --strip-components=1 | ||
| - uses: actions/setup-python@v5 | ||
| with: | ||
| python-version-file: .python-version-default | ||
| - uses: hynek/setup-cached-uv@v2 | ||
| - name: Download coverage data | ||
| uses: actions/download-artifact@v4 | ||
| with: | ||
| pattern: coverage-* | ||
| merge-multiple: true | ||
| - name: Coverage comment | ||
| id: coverage_comment | ||
| uses: py-cov-action/python-coverage-comment-action@v3 | ||
| with: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| MERGE_COVERAGE_FILES: true | ||
| - name: Store Pull Request comment to be posted | ||
| uses: actions/upload-artifact@v4 | ||
| if: steps.coverage_comment.outputs.COMMENT_FILE_WRITTEN == 'true' | ||
| with: | ||
| name: python-coverage-comment-action | ||
| path: python-coverage-comment-action.txt | ||
| # Ensure everything required is passing for branch protection. | ||
| required-checks-pass: | ||
| if: always() | ||
| needs: | ||
| - coverage | ||
| - docs | ||
| - install-dev | ||
| - typing | ||
| - pre-commit | ||
| - check-manifest | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Decide whether the needed jobs succeeded or failed | ||
| uses: re-actors/alls-green@release/v1 | ||
| with: | ||
| jobs: ${{ toJSON(needs) }} | ||
