Migration Immutability workflow (kagent-dev/kagent)

The Migration Immutability workflow from kagent-dev/kagent, 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: kagent-dev/kagent.github/workflows/migration-immutability.yamlLicense Apache-2.0View source

What it does

This is the Migration Immutability workflow from the kagent-dev/kagent 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

workflow (.yml)

name: Migration Immutability

on:
  pull_request:
    branches: [main, "release/**"]
    paths:
      - "go/core/pkg/migrations/**"

jobs:
  check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
        with:
          fetch-depth: 0

      - name: Fail if any existing migration file was modified
        run: |
          # List files under go/core/pkg/migrations/ that were changed relative
          # to the merge base of this PR.  We only care about modifications (M)
          # and renames (R); additions (A) are fine.
          BASE=$(git merge-base HEAD origin/${{ github.base_ref }})
          MODIFIED=$(git diff --name-only --diff-filter=MR "$BASE" HEAD \
            -- 'go/core/pkg/migrations/**/*.sql')

          if [ -n "$MODIFIED" ]; then
            echo "ERROR: The following migration files were modified."
            echo "Migration files are immutable once merged."
            echo "Fix bugs with a new migration instead."
            echo ""
            echo "$MODIFIED"
            exit 1
          fi

          echo "OK: no existing migration files were modified."

The same workflow, on Latchkey

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

name: Migration Immutability
 
on:
  pull_request:
    branches: [main, "release/**"]
    paths:
      - "go/core/pkg/migrations/**"
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  check:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v6
        with:
          fetch-depth: 0
 
      - name: Fail if any existing migration file was modified
        run: |
          # List files under go/core/pkg/migrations/ that were changed relative
          # to the merge base of this PR.  We only care about modifications (M)
          # and renames (R); additions (A) are fine.
          BASE=$(git merge-base HEAD origin/${{ github.base_ref }})
          MODIFIED=$(git diff --name-only --diff-filter=MR "$BASE" HEAD \
            -- 'go/core/pkg/migrations/**/*.sql')
 
          if [ -n "$MODIFIED" ]; then
            echo "ERROR: The following migration files were modified."
            echo "Migration files are immutable once merged."
            echo "Fix bugs with a new migration instead."
            echo ""
            echo "$MODIFIED"
            exit 1
          fi
 
          echo "OK: no existing migration files were modified."

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