test workflow (microsoft/maro)
The test workflow from microsoft/maro, explained and optimized by Latchkey.
F
CI health: F - at risk
Run this on Latchkey for self-healing, caching, and up to 58% lower cost.
Grade your own workflow free or run it on Latchkey →What it does
This is the test workflow from the microsoft/maro repository, a real project running GitHub Actions. It is shown here with attribution under its MIT license.
Below, Latchkey shows a faster, safer version produced by its optimization engine.
The workflow
workflow (.yml)
name: test
on:
push:
branches: [ master, v0.1, v0.2, v0.3 ]
pull_request:
branches: [ master, v0.1, v0.2, v0.3 ]
workflow_dispatch:
jobs:
test:
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ubuntu-18.04, windows-latest, macos-latest]
python-version: [3.7, 3.8, 3.9]
steps:
- uses: actions/checkout@v2
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v2
with:
python-version: ${{ matrix.python-version }}
- name: Install build dependencies
run: |
pip install -r maro/requirements.build.txt
- name: Compile cython files
run: |
cython ./maro/backends/backend.pyx ./maro/backends/np_backend.pyx ./maro/backends/raw_backend.pyx ./maro/backends/frame.pyx --cplus -3 -E NODES_MEMORY_LAYOUT=ONE_BLOCK -X embedsignature=True
- name: Build maro inplace
run: |
python setup.py build_ext -i
- name: Install torch on Windows
if: runner.os == 'Windows'
run: |
pip install torch===1.7.1 torchvision===0.8.2 -f https://download.pytorch.org/whl/torch_stable.html
- name: Install test dependencies
run: |
python -m pip install --upgrade pip
pip install -r tests/requirements.test.txt
pip install flake8
- name: Lint with flake8
run: |
# stop the build if there are Python syntax errors or undefined names
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
# exit-zero treats all errors as warnings.
flake8 . --count --exit-zero --max-complexity=10 --statistics
- name: test on windows
if: runner.os == 'Windows'
env:
PYTHONPATH: .;./tests
run: |
coverage run --rcfile=./tests/.coveragerc
coverage report --rcfile=./tests/.coveragerc
- name: test on linux and macos
if: runner.os == 'Linux' || runner.os == 'macOS'
env:
PYTHONPATH: .:./tests
run: |
coverage run --rcfile=./tests/.coveragerc
coverage xml --rcfile=./tests/.coveragerc
- name: Upload coverage to Codecov
if: runner.os == 'Linux'
uses: codecov/codecov-action@v1
with:
token: ${{ secrets.CODECOV_TOKEN }}
file: ./coverage.xml
flags: unittests
env_vars: OS,PYTHON
name: maro-code-coverage
fail_ci_if_error: false
path_to_write_report: ./codecov_report.gz
The same workflow, on Latchkey
Estimated ~20% faster on cache hits, plus fewer wasted runs and a safer supply chain. Added and changed lines are highlighted.
name: test on: push: branches: [ master, v0.1, v0.2, v0.3 ] pull_request: branches: [ master, v0.1, v0.2, v0.3 ] workflow_dispatch: concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: test: timeout-minutes: 30 runs-on: ${{ matrix.os }} strategy: matrix: os: [ubuntu-18.04, windows-latest, macos-latest] python-version: [3.7, 3.8, 3.9] steps: - uses: actions/checkout@v2 - name: Set up Python ${{ matrix.python-version }} uses: actions/setup-python@v2 with: cache: 'pip' python-version: ${{ matrix.python-version }} - name: Install build dependencies run: | pip install -r maro/requirements.build.txt - name: Compile cython files run: | cython ./maro/backends/backend.pyx ./maro/backends/np_backend.pyx ./maro/backends/raw_backend.pyx ./maro/backends/frame.pyx --cplus -3 -E NODES_MEMORY_LAYOUT=ONE_BLOCK -X embedsignature=True - name: Build maro inplace run: | python setup.py build_ext -i - name: Install torch on Windows if: runner.os == 'Windows' run: | pip install torch===1.7.1 torchvision===0.8.2 -f https://download.pytorch.org/whl/torch_stable.html - name: Install test dependencies run: | python -m pip install --upgrade pip pip install -r tests/requirements.test.txt pip install flake8 - name: Lint with flake8 run: | # stop the build if there are Python syntax errors or undefined names flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics # exit-zero treats all errors as warnings. flake8 . --count --exit-zero --max-complexity=10 --statistics - name: test on windows if: runner.os == 'Windows' env: PYTHONPATH: .;./tests run: | coverage run --rcfile=./tests/.coveragerc coverage report --rcfile=./tests/.coveragerc - name: test on linux and macos if: runner.os == 'Linux' || runner.os == 'macOS' env: PYTHONPATH: .:./tests run: | coverage run --rcfile=./tests/.coveragerc coverage xml --rcfile=./tests/.coveragerc - name: Upload coverage to Codecov if: runner.os == 'Linux' uses: codecov/codecov-action@v1 with: token: ${{ secrets.CODECOV_TOKEN }} file: ./coverage.xml flags: unittests env_vars: OS,PYTHON name: maro-code-coverage fail_ci_if_error: false path_to_write_report: ./codecov_report.gz
What changed
- Cancel superseded runs when a branch or PR gets a newer push.
- Cache dependency installs on the setup step so they are served from cache.
- Add a job timeout so a hung step cannot burn hours of runner time.
1 third-party action is referenced by a movable tag. Pin it to the commit SHA (Latchkey resolves and applies this automatically) so a repointed tag cannot change what runs.
What Latchkey heals here
This workflow has steps that commonly fail on transient issues (network, registries, flaky browsers). On Latchkey managed runners they are detected, retried, and self-healed instead of failing your build:
- Dependency installs
This workflow runs 1 job (9 with the matrix expanded) per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.