CI/CD for the web app (API + frontend) workflow (iusztinpaul/energy-forecasting)

The CI/CD for the web app (API + frontend) workflow from iusztinpaul/energy-forecasting, 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: iusztinpaul/energy-forecasting.github/workflows/ci_cd_web_app.ymlLicense MITView source

What it does

This is the CI/CD for the web app (API + frontend) workflow from the iusztinpaul/energy-forecasting 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

workflow (.yml)

name: CI/CD for the web app (API + frontend)

on:
  push:
    paths-ignore:
      - 'batch-prediction-pipeline/'
      - 'feature-pipeline/'
      - 'training-pipeline'
      - '**/*.yml'
      - '**/*.md'
    branches: [ "main" ]
    
env:
  CLOUDSDK_CORE_PROJECT: '${{ vars.CLOUDSDK_CORE_PROJECT }}'
  USER: '${{ vars.USER }}'
  INSTANCE_NAME: '${{ vars.APP_INSTANCE_NAME }}'
  ZONE: '${{ vars.ZONE }}'

jobs:
  ci_cd:
    runs-on: ubuntu-latest
    steps:
      - uses: 'actions/checkout@v3'

      - id: 'auth'
        uses: 'google-github-actions/auth@v0'
        with:
          credentials_json: '${{ secrets.GCP_CREDENTIALS }}'
      - id: 'compute-ssh'
        uses: 'google-github-actions/ssh-compute@v0'
        with:
          project_id: '${{ env.CLOUDSDK_CORE_PROJECT }}'
          user: '${{ env.USER }}'
          instance_name: '${{ env.INSTANCE_NAME }}'
          zone: '${{ env.ZONE }}'
          ssh_private_key: '${{ secrets.GCP_SSH_PRIVATE_KEY }}'
          command: >
            cd ~/energy-forecasting && 
            git pull && 
            docker compose -f deploy/app-docker-compose.yml --project-directory . up --build -d

The same workflow, on Latchkey

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

name: CI/CD for the web app (API + frontend)
 
on:
  push:
    paths-ignore:
      - 'batch-prediction-pipeline/'
      - 'feature-pipeline/'
      - 'training-pipeline'
      - '**/*.yml'
      - '**/*.md'
    branches: [ "main" ]
    
env:
  CLOUDSDK_CORE_PROJECT: '${{ vars.CLOUDSDK_CORE_PROJECT }}'
  USER: '${{ vars.USER }}'
  INSTANCE_NAME: '${{ vars.APP_INSTANCE_NAME }}'
  ZONE: '${{ vars.ZONE }}'
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  ci_cd:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
      - uses: 'actions/checkout@v3'
 
      - id: 'auth'
        uses: 'google-github-actions/auth@v0'
        with:
          credentials_json: '${{ secrets.GCP_CREDENTIALS }}'
      - id: 'compute-ssh'
        uses: 'google-github-actions/ssh-compute@v0'
        with:
          project_id: '${{ env.CLOUDSDK_CORE_PROJECT }}'
          user: '${{ env.USER }}'
          instance_name: '${{ env.INSTANCE_NAME }}'
          zone: '${{ env.ZONE }}'
          ssh_private_key: '${{ secrets.GCP_SSH_PRIVATE_KEY }}'
          command: >
            cd ~/energy-forecasting && 
            git pull && 
            docker compose -f deploy/app-docker-compose.yml --project-directory . up --build -d

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 1 job per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.