Improve terminal logic #1719
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: test | |
| on: | |
| push: | |
| branches: | |
| - master | |
| pull_request: | |
| branches: | |
| - master | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }} | |
| cancel-in-progress: true | |
| env: | |
| STABLE_PYTHON_VERSION: '3.11' | |
| PYTHONUNBUFFERED: "1" | |
| FORCE_COLOR: "1" | |
| jobs: | |
| run: | |
| name: Python ${{ matrix.python-version }} on ${{ startsWith(matrix.os, 'macos-') && 'macOS' || startsWith(matrix.os, 'windows-') && 'Windows' || 'Linux' }} | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: [ubuntu-latest, windows-latest, macos-latest] | |
| python-version: ['3.8', '3.9', '3.10', '3.11'] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Ensure latest pip | |
| run: python -m pip install --upgrade pip | |
| - name: Install ourself | |
| run: | | |
| pip install -e . | |
| pip install -e ./backend | |
| - if: ${{ !startsWith(matrix.python-version, 'pypy') }} | |
| name: Lint | |
| run: hatch run lint:all | |
| - name: Run tests | |
| run: hatch run full | |
| - name: Disambiguate coverage filename | |
| run: mv .coverage ".coverage.${{ matrix.os }}.${{ matrix.python-version }}" | |
| - name: Upload coverage data | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: coverage-data | |
| path: .coverage.* | |
| coverage: | |
| name: Report coverage | |
| runs-on: ubuntu-latest | |
| needs: | |
| - run | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python ${{ env.STABLE_PYTHON_VERSION }} | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ env.STABLE_PYTHON_VERSION }} | |
| - name: Install Hatch | |
| run: pip install hatch | |
| - name: Trigger build for auto-generated files | |
| run: hatch build --hooks-only | |
| - name: Download coverage data | |
| uses: actions/download-artifact@v3 | |
| with: | |
| name: coverage-data | |
| - name: Combine coverage data | |
| run: hatch run coverage:combine | |
| - name: Export coverage reports | |
| run: | | |
| hatch run coverage:report-xml | |
| hatch run coverage:report-uncovered-html | |
| - name: Upload uncovered HTML report | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: uncovered-html-report | |
| path: htmlcov | |
| - name: Generate coverage summary | |
| run: hatch run coverage:generate-summary | |
| - name: Write coverage summary report | |
| if: github.event_name == 'pull_request' | |
| run: hatch run coverage:write-summary-report | |
| - name: Update coverage pull request comment | |
| if: github.event_name == 'pull_request' && !github.event.pull_request.head.repo.fork | |
| uses: marocchino/sticky-pull-request-comment@v2 | |
| with: | |
| path: coverage-report.md | |
| downstream: | |
| name: Downstream builds with Python ${{ matrix.python-version }} | |
| runs-on: ubuntu-latest | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| python-version: ['3.8', '3.9', '3.10', '3.11'] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install tools | |
| run: pip install --upgrade -r backend/tests/downstream/requirements.txt | |
| - name: Build downstream projects | |
| run: python backend/tests/downstream/integrate.py | |
| response-time: | |
| name: CLI responsiveness with latest Python | |
| runs-on: ubuntu-latest | |
| env: | |
| HYPERFINE_VERSION: '1.12.0' | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python ${{ env.STABLE_PYTHON_VERSION }} | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ env.STABLE_PYTHON_VERSION }} | |
| - name: Install hyperfine | |
| run: | | |
| wget https://github.com/sharkdp/hyperfine/releases/download/v${HYPERFINE_VERSION}/hyperfine_${HYPERFINE_VERSION}_amd64.deb | |
| sudo dpkg -i hyperfine_${HYPERFINE_VERSION}_amd64.deb | |
| - name: Install other tools | |
| run: pip install --upgrade flit poetry pipenv | |
| - name: Install ourself | |
| run: pip install . | |
| - name: Benchmark | |
| run: | | |
| hyperfine -m 100 --warmup 10 -i pipenv | |
| hyperfine -m 100 --warmup 10 poetry | |
| hyperfine -m 100 --warmup 10 -i flit | |
| hyperfine -m 100 --warmup 10 hatch | |
| # https://github.com/marketplace/actions/alls-green#why | |
| check: # This job does nothing and is only used for the branch protection | |
| if: always() | |
| needs: | |
| - coverage | |
| - downstream | |
| - response-time | |
| 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) }} |