Update data workflow (github/github-elements)

The Update data workflow from github/github-elements, explained and optimized by Latchkey.

What it does

This is the Update data workflow from the github/github-elements 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: Update data

on:
  schedule:
    - cron: "0 8 * * *"
  workflow_dispatch:

permissions:
  contents: write

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v2
    - name: Generate data
      uses: actions/setup-node@v1
      with:
        node-version: 15.x
    - run: node generate.js
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
    - name: Commit & Push Generated Data
      run: |
        git config --local user.email "actions@github.com"
        git config --local user.name "Actions Auto Build"
        git add -f .
        git commit -m "docs: generate documents" || true
        git push --force origin HEAD:refs/heads/main

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: Update data
 
on:
  schedule:
    - cron: "0 8 * * *"
  workflow_dispatch:
 
permissions:
  contents: write
 
jobs:
  build:
    timeout-minutes: 30
    runs-on: latchkey-small
 
    steps:
    - uses: actions/checkout@v2
    - name: Generate data
      uses: actions/setup-node@v1
      with:
        cache: 'npm'
        node-version: 15.x
    - run: node generate.js
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
    - name: Commit & Push Generated Data
      run: |
        git config --local user.email "actions@github.com"
        git config --local user.name "Actions Auto Build"
        git add -f .
        git commit -m "docs: generate documents" || true
        git push --force origin HEAD:refs/heads/main
 

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.
• 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.

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

Actions used in this workflow