π§ͺ Test workflow (nksaraf/vinxi)
The π§ͺ Test workflow from nksaraf/vinxi, explained and optimized by Latchkey.
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 →What it does
This is the π§ͺ Test workflow from the nksaraf/vinxi 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
name: π§ͺ Test
on:
push:
branches:
- main
- dev
- release-*
tags-ignore:
- v*
paths-ignore:
- "examples/**"
- "**/README.md"
pull_request:
paths-ignore:
- "examples/**"
- "**/README.md"
env:
CLOUDFLARE_API_TOKEN: ${{ secrets.CF_ACCOUNT_TOKEN }}
CLOUDFLARE_ACCOUNT_ID: ${{ secrets.CF_ACCOUNT_ID }}
jobs:
integration:
name: "π ${{ matrix.adapter }} (os: ${{ matrix.os }}, node: ${{ matrix.node-version }})"
strategy:
fail-fast: false
matrix:
node-version: [18, 20, 22]
# adapter:
# - solid-start-node
# - solid-start-cloudflare-workers
# - solid-start-cloudflare-pages
# - solid-start-deno
os:
- ubuntu-22.04
- macos-latest
- windows-latest
include:
- os: ubuntu-22.04
playwright_binary_path: ~/.cache/ms-playwright
- os: macos-latest
playwright_binary_path: ~/Library/Caches/ms-playwright
- os: windows-latest
playwright_binary_path: '~\\AppData\\Local\\ms-playwright'
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v2
- uses: pnpm/action-setup@v4
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v3
with:
node-version: ${{ matrix.node-version }}
cache: "pnpm"
- name: Install dependencies
run: pnpm install --frozen-lockfile
- name: π΅οΈββοΈ Get current Playwright Test version
id: playwright-version
shell: bash
run: |
# Use Node.js to extract Playwright Test version from package.json
playwright_version=$(node -e "const pkg = require('./test/package.json'); console.log(pkg.dependencies['@playwright/test']);")
# Set the version as an output
echo "::set-output name=version::${playwright_version}"
- name: π€ Cache Playwright binaries
uses: actions/cache@v3
id: playwright-cache
with:
path: ${{ matrix.playwright_binary_path }}
key: ${{ runner.os }}-${{ runner.arch }}-cache-playwright-${{ steps.playwright-version.outputs.version }}
- name: π¨οΈ Playwright info
shell: bash
run: |
echo "OS: ${{ matrix.os }}"
echo "Playwright version: ${{ steps.playwright-version.outputs.version }}"
echo "Playwright install dir: ${{ matrix.playwright_binary_path }}"
echo "Cache key: ${{ runner.os }}-${{ runner.arch }}-cache-playwright-${{ steps.playwright-version.outputs.version }}"
echo "Cache hit: ${{ steps.playwright-cache.outputs.cache-hit == 'true' }}"
- name: π₯ Install Playwright
if: steps.playwright-cache.outputs.cache-hit != 'true'
run: pnpm run install:playwright
- uses: oven-sh/setup-bun@v1
if: runner.os == 'ubuntu-22.04' || runner.os == 'macos-latest'
with:
bun-version: latest
- name: π Build things that need to be built
if: runner.os == 'ubuntu-22.04' || runner.os == 'macos-latest'
env:
START_ADAPTER: ${{ matrix.adapter }}
run: npm run build
- name: π Run Integration Tests
env:
START_ADAPTER: ${{ matrix.adapter }}
run: npm run test
# - name: Archive test results
# uses: actions/upload-artifact@v3
# with:
# name: test-results
# path: |
# test/.fixtures
# !test/.fixtures/**/node_modules
The same workflow, on Latchkey
Removes redundant runs and caps runaway jobs. Added and changed lines are highlighted.
name: π§ͺ Test on: push: branches: - main - dev - release-* tags-ignore: - v* paths-ignore: - "examples/**" - "**/README.md" pull_request: paths-ignore: - "examples/**" - "**/README.md" env: CLOUDFLARE_API_TOKEN: ${{ secrets.CF_ACCOUNT_TOKEN }} CLOUDFLARE_ACCOUNT_ID: ${{ secrets.CF_ACCOUNT_ID }} concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: integration: timeout-minutes: 30 name: "π ${{ matrix.adapter }} (os: ${{ matrix.os }}, node: ${{ matrix.node-version }})" strategy: fail-fast: false matrix: node-version: [18, 20, 22] # adapter: # - solid-start-node # - solid-start-cloudflare-workers # - solid-start-cloudflare-pages # - solid-start-deno os: - ubuntu-22.04 - macos-latest - windows-latest include: - os: ubuntu-22.04 playwright_binary_path: ~/.cache/ms-playwright - os: macos-latest playwright_binary_path: ~/Library/Caches/ms-playwright - os: windows-latest playwright_binary_path: '~\\AppData\\Local\\ms-playwright' runs-on: ${{ matrix.os }} steps: - uses: actions/checkout@v2 - uses: pnpm/action-setup@v4 - name: Use Node.js ${{ matrix.node-version }} uses: actions/setup-node@v3 with: node-version: ${{ matrix.node-version }} cache: "pnpm" - name: Install dependencies run: pnpm install --frozen-lockfile - name: π΅οΈββοΈ Get current Playwright Test version id: playwright-version shell: bash run: | # Use Node.js to extract Playwright Test version from package.json playwright_version=$(node -e "const pkg = require('./test/package.json'); console.log(pkg.dependencies['@playwright/test']);") # Set the version as an output echo "::set-output name=version::${playwright_version}" - name: π€ Cache Playwright binaries uses: actions/cache@v3 id: playwright-cache with: path: ${{ matrix.playwright_binary_path }} key: ${{ runner.os }}-${{ runner.arch }}-cache-playwright-${{ steps.playwright-version.outputs.version }} - name: π¨οΈ Playwright info shell: bash run: | echo "OS: ${{ matrix.os }}" echo "Playwright version: ${{ steps.playwright-version.outputs.version }}" echo "Playwright install dir: ${{ matrix.playwright_binary_path }}" echo "Cache key: ${{ runner.os }}-${{ runner.arch }}-cache-playwright-${{ steps.playwright-version.outputs.version }}" echo "Cache hit: ${{ steps.playwright-cache.outputs.cache-hit == 'true' }}" - name: π₯ Install Playwright if: steps.playwright-cache.outputs.cache-hit != 'true' run: pnpm run install:playwright - uses: oven-sh/setup-bun@v1 if: runner.os == 'ubuntu-22.04' || runner.os == 'macos-latest' with: bun-version: latest - name: π Build things that need to be built if: runner.os == 'ubuntu-22.04' || runner.os == 'macos-latest' env: START_ADAPTER: ${{ matrix.adapter }} run: npm run build - name: π Run Integration Tests env: START_ADAPTER: ${{ matrix.adapter }} run: npm run test # - name: Archive test results # uses: actions/upload-artifact@v3 # with: # name: test-results # path: | # test/.fixtures # !test/.fixtures/**/node_modules
What changed
- 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.
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:
- Dependency installs
- End-to-end and browser tests
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.