Skip to content
Latchkey

CI-Serving workflow (massquantity/LibRecommender)

The CI-Serving workflow from massquantity/LibRecommender, explained and optimized by Latchkey.

C

CI health: C - fair

Run this on Latchkey for self-healing, caching, and up to 58% lower cost.

Grade your own workflow free or run it on Latchkey →
Source: massquantity/LibRecommender.github/workflows/ci_serving.ymlLicense MITView source

What it does

This is the CI-Serving workflow from the massquantity/LibRecommender 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: CI-Serving

on:
  push:
    branches:
      - master
  pull_request:
    branches:
      - master
  # Manual run
  workflow_dispatch:

jobs:
  testing:
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-22.04]
        python-version: [3.9, '3.10', '3.11']

    steps:
      - uses: actions/checkout@v4
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}
          cache: 'pip'

      - name: Display Python version
        run: python -c "import sys; print(sys.version)"

      - name: Install dependencies
        run: |
          python -m pip install -U pip wheel setuptools
          python -m pip install numpy>=1.19.5
          python -m pip install "scipy>=1.2.1,<1.13.0"
          python -m pip install pandas>=1.0.0
          python -m pip install scikit-learn>=0.20.0
          python -m pip install "tensorflow>=1.15.0,<2.16.0"
          python -m pip install torch>=1.10.0
          python -m pip install gensim>=4.0.0
          python -m pip install tqdm
          python -m pip install recfarm
          python -m pip install -r requirements-serving.txt
          python -m pip install -e .

      - name: Set up Redis
        uses: shogo82148/actions-setup-redis@v1
        with:
          redis-version: '7.x'

      - name: Test Redis
        run: redis-cli ping

      - name: Test
        run: |
          python -m pip install pytest
          python -m pytest tests/serving
        if: matrix.python-version != '3.10'

      - name: Test with coverage
        run: |
          python -m pip install pytest coverage
          bash tests/serving/setup_coverage.sh
          coverage --version && coverage erase
          coverage run -m pytest tests/serving
          coverage combine && coverage report
          coverage xml
        if: matrix.python-version == '3.10'

      - name: Upload coverage to Codecov
        uses: codecov/codecov-action@v4
        with:
          file: ./coverage.xml
          flags: CI
          name: python${{ matrix.python-version }}-serving
          token: ${{ secrets.CODECOV_TOKEN }}
          fail_ci_if_error: false
          verbose: true
        if: matrix.python-version == '3.10'

The same workflow, on Latchkey

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

name: CI-Serving
 
on:
  push:
    branches:
      - master
  pull_request:
    branches:
      - master
  # Manual run
  workflow_dispatch:
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  testing:
    timeout-minutes: 30
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-22.04]
        python-version: [3.9, '3.10', '3.11']
 
    steps:
      - uses: actions/checkout@v4
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}
          cache: 'pip'
 
      - name: Display Python version
        run: python -c "import sys; print(sys.version)"
 
      - name: Install dependencies
        run: |
          python -m pip install -U pip wheel setuptools
          python -m pip install numpy>=1.19.5
          python -m pip install "scipy>=1.2.1,<1.13.0"
          python -m pip install pandas>=1.0.0
          python -m pip install scikit-learn>=0.20.0
          python -m pip install "tensorflow>=1.15.0,<2.16.0"
          python -m pip install torch>=1.10.0
          python -m pip install gensim>=4.0.0
          python -m pip install tqdm
          python -m pip install recfarm
          python -m pip install -r requirements-serving.txt
          python -m pip install -e .
 
      - name: Set up Redis
        uses: shogo82148/actions-setup-redis@v1
        with:
          redis-version: '7.x'
 
      - name: Test Redis
        run: redis-cli ping
 
      - name: Test
        run: |
          python -m pip install pytest
          python -m pytest tests/serving
        if: matrix.python-version != '3.10'
 
      - name: Test with coverage
        run: |
          python -m pip install pytest coverage
          bash tests/serving/setup_coverage.sh
          coverage --version && coverage erase
          coverage run -m pytest tests/serving
          coverage combine && coverage report
          coverage xml
        if: matrix.python-version == '3.10'
 
      - name: Upload coverage to Codecov
        uses: codecov/codecov-action@v4
        with:
          file: ./coverage.xml
          flags: CI
          name: python${{ matrix.python-version }}-serving
          token: ${{ secrets.CODECOV_TOKEN }}
          fail_ci_if_error: false
          verbose: true
        if: matrix.python-version == '3.10'
 

What changed

2 third-party actions are referenced by a movable tag. Pin them 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:

This workflow runs 1 job (3 with the matrix expanded) per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.

Actions used in this workflow