setup workflow (Ar9av/obsidian-wiki)

The setup workflow from Ar9av/obsidian-wiki, 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: Ar9av/obsidian-wiki.github/workflows/setup.ymlLicense MITView source

What it does

This is the setup workflow from the Ar9av/obsidian-wiki 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: setup

# Guards setup.sh against the regression where it rewrites committed
# relative symlinks with absolute paths (or any other modification to
# tracked files). See #52 for the original bug.

on:
  push:
    branches: [main]
  pull_request:

jobs:
  install-leaves-tree-clean:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Run setup.sh
        # stdin closed so the vault-path prompt returns empty rather than hang
        run: bash setup.sh < /dev/null
      - name: Working tree must be unchanged
        run: |
          if ! git diff --exit-code; then
            echo "::error::setup.sh modified tracked files. Likely cause: an" \
                 "in-repo symlink mirror is being written with an absolute" \
                 "target instead of a relative one. See install_skills() in setup.sh."
            exit 1
          fi
      - name: Re-run is idempotent
        run: bash setup.sh < /dev/null && git diff --exit-code

The same workflow, on Latchkey

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

name: setup
 
# Guards setup.sh against the regression where it rewrites committed
# relative symlinks with absolute paths (or any other modification to
# tracked files). See #52 for the original bug.
 
on:
  push:
    branches: [main]
  pull_request:
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  install-leaves-tree-clean:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v4
      - name: Run setup.sh
        # stdin closed so the vault-path prompt returns empty rather than hang
        run: bash setup.sh < /dev/null
      - name: Working tree must be unchanged
        run: |
          if ! git diff --exit-code; then
            echo "::error::setup.sh modified tracked files. Likely cause: an" \
                 "in-repo symlink mirror is being written with an absolute" \
                 "target instead of a relative one. See install_skills() in setup.sh."
            exit 1
          fi
      - name: Re-run is idempotent
        run: bash setup.sh < /dev/null && git diff --exit-code

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

actions/checkout