Deploy RAWGraphs dev workflow (rawgraphs/rawgraphs-app)
The Deploy RAWGraphs dev workflow from rawgraphs/rawgraphs-app, explained and optimized by Latchkey.
CI health: F - at risk
Point runs-on at Latchkey and get caching, run de-duplication, job timeouts, SHA-pinned actions, self-healing for flaky steps, and up to 58% lower cost, applied automatically.
What it does
This is the Deploy RAWGraphs dev workflow from the rawgraphs/rawgraphs-app 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
name: Deploy RAWGraphs dev
# Controls when the action will run. Triggers the workflow on push or pull request
# events but only for tagged versions
on:
push:
branches: [master]
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
deploy:
# The type of runner that the job will run on
runs-on: ubuntu-latest
# Steps represent a sequence of tasks that will be executed as part of the job
steps:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- uses: actions/checkout@v3
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v3
with:
node-version: 14.x
- name: Get yarn cache directory path
id: yarn-cache-dir-path
run: echo "dir=$(yarn cache dir)" >> "$GITHUB_OUTPUT"
- uses: actions/cache@v3
id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
with:
path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
restore-keys: |
${{ runner.os }}-yarn-
- name: Install dependencies
run: yarn install
- name: Get short git hash
id: vars
run: echo "sha_short=$(git rev-parse --short HEAD)" >> $GITHUB_OUTPUT
- name: Build app
run: yarn build
env:
CI: false
REACT_APP_VERSION: ${{ steps.vars.outputs.sha_short }}
- name: List output files
run: find build/ -print
- name: FTP Deploy
uses: SamKirkland/FTP-Deploy-Action@v4.3.4
with:
# Deployment destination server & path. Formatted as protocol://domain.com:port/full/destination/path/
server: dev.rawgraphs.io
# FTP account username
username: ${{ secrets.FTP_USERNAME }}
# FTP account password
password: ${{ secrets.FTP_PASSWORD }}
# The local folder to copy, defaults to root project folder
local-dir: build/
server-dir: dev.rawgraphs.io/
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: Deploy RAWGraphs dev # Controls when the action will run. Triggers the workflow on push or pull request # events but only for tagged versions on: push: branches: [master] # A workflow run is made up of one or more jobs that can run sequentially or in parallel concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: deploy: timeout-minutes: 30 # The type of runner that the job will run on runs-on: latchkey-small # Steps represent a sequence of tasks that will be executed as part of the job steps: # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it - uses: actions/checkout@v3 - name: Use Node.js ${{ matrix.node-version }} uses: actions/setup-node@v3 with: cache: 'npm' node-version: 14.x - name: Get yarn cache directory path id: yarn-cache-dir-path run: echo "dir=$(yarn cache dir)" >> "$GITHUB_OUTPUT" - uses: actions/cache@v3 id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`) with: path: ${{ steps.yarn-cache-dir-path.outputs.dir }} key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }} restore-keys: | ${{ runner.os }}-yarn- - name: Install dependencies run: yarn install - name: Get short git hash id: vars run: echo "sha_short=$(git rev-parse --short HEAD)" >> $GITHUB_OUTPUT - name: Build app run: yarn build env: CI: false REACT_APP_VERSION: ${{ steps.vars.outputs.sha_short }} - name: List output files run: find build/ -print - name: FTP Deploy uses: SamKirkland/FTP-Deploy-Action@v4.3.4 with: # Deployment destination server & path. Formatted as protocol://domain.com:port/full/destination/path/ server: dev.rawgraphs.io # FTP account username username: ${{ secrets.FTP_USERNAME }} # FTP account password password: ${{ secrets.FTP_PASSWORD }} # The local folder to copy, defaults to root project folder local-dir: build/ server-dir: dev.rawgraphs.io/
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.
1 third-party action is referenced by a movable tag. Pin it 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
This workflow runs 1 job per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.