Pytest && Sync to Hugging Face hub workflow (robinhad/ukrainian-tts)

The Pytest && Sync to Hugging Face hub workflow from robinhad/ukrainian-tts, explained and optimized by Latchkey.

CI health: D - needs work

Point runs-on at Latchkey and get caching, run de-duplication, job timeouts, self-healing for flaky steps, and up to 58% lower cost, applied automatically.

Grade your own workflow free or run it on Latchkey →

Source: robinhad/ukrainian-tts.github/workflows/hf-sync.ymlLicense MITView source

What it does

This is the Pytest && Sync to Hugging Face hub workflow from the robinhad/ukrainian-tts 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: Pytest && Sync to Hugging Face hub
on:
  push:
    branches: [main]

  # to run this workflow manually from the Actions tab
  workflow_dispatch:
  schedule:
    - cron: '0 18 1 * *'

jobs:
  windows:
    name: Run pytest on Windows
    runs-on: windows-latest
    steps:
      - uses: actions/checkout@v1
      - uses: actions/setup-python@v1
        with:
          python-version: '3.10'
      - name: Test windows-latest binding
        run: |
          python -m venv venv3
          venv3\Scripts\Activate.ps1
          python -m pip install .
          python -m pip install -r requirements-test.txt
          python -m pytest

  build:
    name: Run pytest and checks
    runs-on: ubuntu-latest
    #strategy:
    #  matrix:
    #    python-version: ["3.7", "3.8", "3.9", "3.10"]

    steps:
      - uses: actions/checkout@v3
      - name: Set up Python 3.10 #${{ matrix.python-version }}
        uses: actions/setup-python@v4
        with:
          python-version: '3.10' #${{ matrix.python-version }}
      - name: Install libsndfile1
        run: sudo apt-get update && sudo apt-get install -y libsndfile1
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -r requirements-test.txt
      - name: Check code with black
        run: |
           black --check .
      #- 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. The GitHub editor is 127 chars wide
      #    flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -r requirements.txt
      - name: Test with pytest
        run: |
          pytest
  sync-to-hub:
    runs-on: ubuntu-latest
    needs: [build,windows]
    steps:
      - uses: actions/checkout@v2
        with:
          fetch-depth: 0
      - name: Push to hub
        env:
          HF_TOKEN: ${{ secrets.HF_TOKEN }}
        run: git push -f https://robinhad:$HF_TOKEN@huggingface.co/spaces/robinhad/ukrainian-tts main

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: Pytest && Sync to Hugging Face hub
on:
  push:
    branches: [main]
 
  # to run this workflow manually from the Actions tab
  workflow_dispatch:
  schedule:
    - cron: '0 18 1 * *'
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  windows:
    timeout-minutes: 30
    name: Run pytest on Windows
    runs-on: windows-latest
    steps:
      - uses: actions/checkout@v1
      - uses: actions/setup-python@v1
        with:
          cache: 'pip'
          python-version: '3.10'
      - name: Test windows-latest binding
        run: |
          python -m venv venv3
          venv3\Scripts\Activate.ps1
          python -m pip install .
          python -m pip install -r requirements-test.txt
          python -m pytest
 
  build:
    timeout-minutes: 30
    name: Run pytest and checks
    runs-on: latchkey-small
    #strategy:
    #  matrix:
    #    python-version: ["3.7", "3.8", "3.9", "3.10"]
 
    steps:
      - uses: actions/checkout@v3
      - name: Set up Python 3.10 #${{ matrix.python-version }}
        uses: actions/setup-python@v4
        with:
          cache: 'pip'
          python-version: '3.10' #${{ matrix.python-version }}
      - name: Install libsndfile1
        run: sudo apt-get update && sudo apt-get install -y libsndfile1
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -r requirements-test.txt
      - name: Check code with black
        run: |
           black --check .
      #- 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. The GitHub editor is 127 chars wide
      #    flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -r requirements.txt
      - name: Test with pytest
        run: |
          pytest
  sync-to-hub:
    timeout-minutes: 30
    runs-on: latchkey-small
    needs: [build,windows]
    steps:
      - uses: actions/checkout@v2
        with:
          fetch-depth: 0
      - name: Push to hub
        env:
          HF_TOKEN: ${{ secrets.HF_TOKEN }}
        run: git push -f https://robinhad:$HF_TOKEN@huggingface.co/spaces/robinhad/ukrainian-tts main

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.
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.

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

Actions used in this workflow

actions/checkout actions/setup-python