controller tests workflow (cyclops-ui/cyclops)

The controller tests workflow from cyclops-ui/cyclops, explained and optimized by Latchkey.

CI health: C - fair

Point runs-on at Latchkey and get 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: cyclops-ui/cyclops.github/workflows/controller-test.ymlLicense Apache-2.0View source

What it does

This is the controller tests workflow from the cyclops-ui/cyclops 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

workflow (.yml)

name: controller tests

on:
  pull_request:
    paths:
      - 'cyclops-ctrl/**'
  push:
    paths:
      - 'cyclops-ctrl/**'
    branches:
      - main

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v2
      - name: Unit tests
        working-directory: cyclops-ctrl
        run: |
          make unit-test

  validate-crd-updates:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v2

      - name: Validate Module
        working-directory: cyclops-ctrl
        run: |
          diff \
            <(yq -N 'select(.kind == "CustomResourceDefinition" and .metadata.name == "modules.cyclops-ui.com")' ../install/cyclops-install.yaml) \
            <(yq -N config/crd/bases/cyclops-ui.com_modules.yaml)
      - name: Validate TemplateAuthRule
        working-directory: cyclops-ctrl
        run: |
          diff \
            <(yq -N 'select(.kind == "CustomResourceDefinition" and .metadata.name == "templateauthrules.cyclops-ui.com")' ../install/cyclops-install.yaml) \
            <(yq -N config/crd/bases/cyclops-ui.com_templateauthrules.yaml)
      - name: Validate TemplateStore
        working-directory: cyclops-ctrl
        run: |
          diff \
            <(yq -N 'select(.kind == "CustomResourceDefinition" and .metadata.name == "templatestores.cyclops-ui.com")' ../install/cyclops-install.yaml) \
            <(yq -N config/crd/bases/cyclops-ui.com_templatestores.yaml)

The same workflow, on Latchkey

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

name: controller tests
 
on:
  pull_request:
    paths:
      - 'cyclops-ctrl/**'
  push:
    paths:
      - 'cyclops-ctrl/**'
    branches:
      - main
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  test:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
      - name: Checkout repository
        uses: actions/checkout@v2
      - name: Unit tests
        working-directory: cyclops-ctrl
        run: |
          make unit-test
 
  validate-crd-updates:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
      - name: Checkout repository
        uses: actions/checkout@v2
 
      - name: Validate Module
        working-directory: cyclops-ctrl
        run: |
          diff \
            <(yq -N 'select(.kind == "CustomResourceDefinition" and .metadata.name == "modules.cyclops-ui.com")' ../install/cyclops-install.yaml) \
            <(yq -N config/crd/bases/cyclops-ui.com_modules.yaml)
      - name: Validate TemplateAuthRule
        working-directory: cyclops-ctrl
        run: |
          diff \
            <(yq -N 'select(.kind == "CustomResourceDefinition" and .metadata.name == "templateauthrules.cyclops-ui.com")' ../install/cyclops-install.yaml) \
            <(yq -N config/crd/bases/cyclops-ui.com_templateauthrules.yaml)
      - name: Validate TemplateStore
        working-directory: cyclops-ctrl
        run: |
          diff \
            <(yq -N 'select(.kind == "CustomResourceDefinition" and .metadata.name == "templatestores.cyclops-ui.com")' ../install/cyclops-install.yaml) \
            <(yq -N config/crd/bases/cyclops-ui.com_templatestores.yaml)

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.

This workflow runs 2 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