2nd Gen CI Tests workflow (firebase/functions-samples)
The 2nd Gen CI Tests workflow from firebase/functions-samples, 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.
What it does
This is the 2nd Gen CI Tests workflow from the firebase/functions-samples 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
# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
name: 2nd Gen CI Tests
on:
pull_request:
paths:
- 'Node/**'
- 'package.json'
- 'package-lock.json'
- 'pnpm-workspace.yaml'
- 'pnpm-lock.yaml'
- 'tsconfig.template.json'
push:
branches:
- main
paths:
- 'Node/**'
- 'package.json'
- 'package-lock.json'
- 'pnpm-workspace.yaml'
- 'pnpm-lock.yaml'
- 'tsconfig.template.json'
env:
CI: true
jobs:
unit:
runs-on: ubuntu-latest
strategy:
matrix:
node-version:
# The latest Node version for 2nd gen
# https://cloud.google.com/functions/docs/runtime-support#node.js
- 22.x
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
- name: Cache npm
uses: actions/cache@v4
with:
path: ~/.npm
key: ${{ runner.os }}-node-${{ matrix.node-version }}-${{ hashFiles('**/package-lock.json') }}
- run: npm install
- run: npm run bootstrap-2nd-gen
- run: npm run lint-2nd-gen
- run: npm run compile-2nd-gen
- run: npm run test-2nd-gen
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.
# Copyright 2023 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. name: 2nd Gen CI Tests on: pull_request: paths: - 'Node/**' - 'package.json' - 'package-lock.json' - 'pnpm-workspace.yaml' - 'pnpm-lock.yaml' - 'tsconfig.template.json' push: branches: - main paths: - 'Node/**' - 'package.json' - 'package-lock.json' - 'pnpm-workspace.yaml' - 'pnpm-lock.yaml' - 'tsconfig.template.json' env: CI: true concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: unit: timeout-minutes: 30 runs-on: latchkey-small strategy: matrix: node-version: # The latest Node version for 2nd gen # https://cloud.google.com/functions/docs/runtime-support#node.js - 22.x steps: - uses: actions/checkout@v4 - uses: actions/setup-node@v4 with: cache: 'npm' node-version: ${{ matrix.node-version }} - name: Cache npm uses: actions/cache@v4 with: path: ~/.npm key: ${{ runner.os }}-node-${{ matrix.node-version }}-${{ hashFiles('**/package-lock.json') }} - run: npm install - run: npm run bootstrap-2nd-gen - run: npm run lint-2nd-gen - run: npm run compile-2nd-gen - run: npm run test-2nd-gen
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 useslatchkey-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 1 job per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.