Generate Swagger Documentation workflow (pwndoc/pwndoc)

The Generate Swagger Documentation workflow from pwndoc/pwndoc, explained and optimized by Latchkey.

What it does

This is the Generate Swagger Documentation workflow from the pwndoc/pwndoc 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: Generate Swagger Documentation

on:
  push:
    branches: [ "main" ]
  pull_request:
    branches: [ "main" ]

jobs:
  build:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v3
    - name: Run the Swagger doc generation script
      working-directory: backend
      run: |
        npm i
        npm run generate-api-doc

The same workflow, on Latchkey

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

name: Generate Swagger Documentation
 
on:
  push:
    branches: [ "main" ]
  pull_request:
    branches: [ "main" ]
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  build:
    timeout-minutes: 30
 
    runs-on: latchkey-small
 
    steps:
    - uses: actions/checkout@v3
    - name: Run the Swagger doc generation script
      working-directory: backend
      run: |
        npm i
        npm run generate-api-doc
 

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.

Actions used in this workflow