build_pat workflow (hyz-xmaster/swa_object_detection)

The build_pat workflow from hyz-xmaster/swa_object_detection, explained and optimized by Latchkey.

What it does

This is the build_pat workflow from the hyz-xmaster/swa_object_detection repository, a real project running GitHub Actions. It is shown here with attribution under its Apache-2.0 license.

Below, Latchkey shows a faster, safer version produced by its optimization engine.

The workflow

name: build_pat

on: push

jobs:
  build_parrots:
    runs-on: ubuntu-latest
    container:
      image: ghcr.io/sunnyxiaohu/parrots-mmcv:1.2.1
      credentials:
        username: sunnyxiaohu
        password: ${{secrets.CR_PAT}}

    steps:
      - uses: actions/checkout@v2
      - name: Install mmdet dependencies
        run: |
          git clone https://github.com/open-mmlab/mmcv.git && cd mmcv
          MMCV_WITH_OPS=1 python setup.py install
          cd .. && rm -rf mmcv
          python -c 'import mmcv; print(mmcv.__version__)'
          pip install -r requirements.txt
      - name: Build and install
        run: rm -rf .eggs && pip install -e .

The same workflow, on Latchkey

Removes redundant runs and caps runaway jobs. Added and changed lines are highlighted.

name: build_pat
 
on: push
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  build_parrots:
    timeout-minutes: 30
    runs-on: latchkey-small
    container:
      image: ghcr.io/sunnyxiaohu/parrots-mmcv:1.2.1
      credentials:
        username: sunnyxiaohu
        password: ${{secrets.CR_PAT}}
 
    steps:
      - uses: actions/checkout@v2
      - name: Install mmdet dependencies
        run: |
          git clone https://github.com/open-mmlab/mmcv.git && cd mmcv
          MMCV_WITH_OPS=1 python setup.py install
          cd .. && rm -rf mmcv
          python -c 'import mmcv; print(mmcv.__version__)'
          pip install -r requirements.txt
      - name: Build and install
        run: rm -rf .eggs && pip install -e .
 

What changed

• Run on Latchkey managed runners with one line (runs-on), which apply the fixes below automatically and self-heal transient failures. This example uses latchkey-small; pick the runner size that fits the job.
• Cancel superseded runs when a branch or PR gets a newer push.
• Add a job timeout so a hung step cannot burn hours of runner time.

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 per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.

Actions used in this workflow