Switch readme to use Markdown #19
Workflow file for this run
This file contains hidden or 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: Tests | |
| on: | |
| push: | |
| branches: | |
| - main | |
| tags: | |
| - '**' | |
| pull_request: | |
| env: | |
| FORCE_COLOR: 1 | |
| jobs: | |
| test: | |
| name: Run tests | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| python-version: ['3.9', '3.10', '3.11', '3.12', '3.13', '3.14'] | |
| os: [ubuntu-latest, macos-latest, windows-latest] | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| persist-credentials: false | |
| - uses: astral-sh/setup-uv@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install dependencies | |
| run: uv sync --group tests | |
| - name: Run tests | |
| run: make test | |
| env: | |
| COVERAGE_FILE: coverage/.coverage.${{ runner.os }}-py${{ matrix.python-version }} | |
| - name: Store coverage files | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: coverage-${{ matrix.os }}-${{ matrix.python-version }} | |
| path: coverage | |
| include-hidden-files: true | |
| test-typing-extensions: | |
| name: Run test on typing-extensions | |
| runs-on: ubuntu-latest | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| typing-extensions: [main, lowest] | |
| python-version: ['3.9', '3.10', '3.11', '3.12', '3.13', '3.14'] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: astral-sh/setup-uv@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install dependencies and typing-extensions main | |
| run: | | |
| uv sync --group tests | |
| uv pip install 'typing-extensions @ git+https://github.com/python/typing_extensions.git' | |
| if: matrix.typing-extensions == 'main' | |
| - name: Install lowest dependencies | |
| run: uv sync --group tests --resolution lowest-direct | |
| if: matrix.typing-extensions == 'lowest' | |
| - name: Run tests | |
| run: make test | |
| docs: | |
| name: Build and check documentation | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: astral-sh/setup-uv@v5 | |
| with: | |
| python-version: '3.13' | |
| - name: Install dependencies | |
| run: uv sync --group docs | |
| - name: Lint docs with sphinx-lint | |
| run: sphinx-lint docs | |
| - name: Build docs and check the integrity of external links | |
| run: | | |
| sphinx-build --builder linkcheck --fail-on-warning "source" "build" | |
| sphinx-build --builder html --fail-on-warning "source" "build" | |
| working-directory: | |
| ./docs | |
| coverage-combine: | |
| needs: test | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| persist-credentials: false | |
| - uses: astral-sh/setup-uv@v5 | |
| with: | |
| python-version: '3.13' | |
| - name: Install dependencies | |
| run: uv sync --group tests | |
| - name: Get coverage files | |
| uses: actions/download-artifact@v4 | |
| with: | |
| merge-multiple: true | |
| pattern: coverage-* | |
| path: coverage | |
| - run: | | |
| ls -la coverage/ | |
| coverage combine coverage/ | |
| coverage report | |
| coverage html --show-contexts --title "typing-inspection coverage for ${{ github.sha }}" | |
| - name: Store coverage data | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: coverage-data | |
| path: .coverage | |
| include-hidden-files: true | |
| - name: Store coverage HTML | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: coverage-html | |
| path: htmlcov | |
| coverage-pr-comment: | |
| needs: coverage-combine | |
| runs-on: ubuntu-latest | |
| if: github.event_name == 'pull_request' | |
| permissions: | |
| pull-requests: write | |
| contents: write | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Download coverage data | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: coverage-data | |
| - name: Generate coverage comment | |
| id: coverage-comment | |
| uses: py-cov-action/python-coverage-comment-action@v3 | |
| with: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Store coverage comment | |
| 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 |