Sync docs workflow (gofiber/recipes)

The Sync docs workflow from gofiber/recipes, explained and optimized by Latchkey.

What it does

This is the Sync docs workflow from the gofiber/recipes 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: Sync docs

on:
  push:
    branches: [main, master]
    paths: ['**/*.md']
  workflow_dispatch:

concurrency:
  group: ${{ github.workflow }}
  cancel-in-progress: false

permissions:
  contents: read

jobs:
  sync:
    uses: gofiber/.github/.github/workflows/sync-docs.yml@main
    with:
      destination-dir: docs/recipes
      file-patterns: '*.md,*.png,*.jpg,*.jpeg,*.gif,*.bmp,*.svg,*.webp'
      exclude-patterns: vendor,.github
      commit-url: https://github.com/gofiber/recipes
      event-mode: push
    secrets:
      doc-sync-token: ${{ secrets.DOC_SYNC_TOKEN }}

The same workflow, on Latchkey

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

name: Sync docs
 
on:
  push:
    branches: [main, master]
    paths: ['**/*.md']
  workflow_dispatch:
 
concurrency:
  group: ${{ github.workflow }}
  cancel-in-progress: false
 
permissions:
  contents: read
 
jobs:
  sync:
    timeout-minutes: 30
    uses: gofiber/.github/.github/workflows/sync-docs.yml@main
    with:
      destination-dir: docs/recipes
      file-patterns: '*.md,*.png,*.jpg,*.jpeg,*.gif,*.bmp,*.svg,*.webp'
      exclude-patterns: vendor,.github
      commit-url: https://github.com/gofiber/recipes
      event-mode: push
    secrets:
      doc-sync-token: ${{ secrets.DOC_SYNC_TOKEN }}
 

What changed

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

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