Update schema.json and docs based on mcquic.config.ConfigSchema workflow (xiaosu-zhu/McQuic)

The Update schema.json and docs based on mcquic.config.ConfigSchema workflow from xiaosu-zhu/McQuic, explained and optimized by Latchkey.

What it does

This is the Update schema.json and docs based on mcquic.config.ConfigSchema workflow from the xiaosu-zhu/McQuic 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: Update schema.json and docs based on mcquic.config.ConfigSchema

on:
  push:
    branches: [main]
    paths: ['mcquic/config.py']

jobs:
  update-schema:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Generate schema.json
        run: |
          pip install marshmallow-jsonschema json-schema-for-humans
          python ci/pre_commit/generate_schema.py mcquic/config.py configs/schema.json configs/schema.md
      - uses: stefanzweifel/git-auto-commit-action@v4
        with:
          commit_message: Auto update config schema and configs/schema.md

The same workflow, on Latchkey

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

name: Update schema.json and docs based on mcquic.config.ConfigSchema
 
on:
  push:
    branches: [main]
    paths: ['mcquic/config.py']
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  update-schema:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v3
      - name: Generate schema.json
        run: |
          pip install marshmallow-jsonschema json-schema-for-humans
          python ci/pre_commit/generate_schema.py mcquic/config.py configs/schema.json configs/schema.md
      - uses: stefanzweifel/git-auto-commit-action@v4
        with:
          commit_message: Auto update config schema and configs/schema.md
 

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.

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.

Actions used in this workflow