skills.rest
vellum-ai
vellum-aiOFFICIAL
Explore all skills by this author →
Website𝕏@vellum_aiGitHub

vellum-migration-checklist

Validate database and workspace migrations against append-only, idempotent conventions.

1.2k|166|Updated Feb 7, 2026
Search Tags:#idempotent#Testing#backfill#Schema#typeScript#workspace migration#Database migration
One-click install
npx skills add https://github.com/vellum-ai/vellum-assistant --skill vellum-migration-checklist
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: vellum-migration-checklist
Source: https://github.com/vellum-ai/vellum-assistant/tree/main/.cursor/skills/vellum-migration-checklist
Command: npx skills add https://github.com/vellum-ai/vellum-assistant --skill vellum-migration-checklist

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It prevents broken or inconsistent database and workspace migrations by enforcing a checklist of conventions for adding, registering, and testing migration files in the Vellum Assistant codebase.

Core Features & Use Cases

  • DB Migration Rules: Guides adding idempotent migration files under assistant/src/persistence/migrations/, registering them in migrationSteps, and adding focused db-*migration*.test.ts tests.
  • Workspace Migration Rules: Covers numbered workspace migration files, registration in WORKSPACE_MIGRATIONS, and workspace-migration-*.test.ts test coverage.
  • Release Notes Guardrails: Explains that release-note workspace migrations are frozen by a feature-flag guard test and must not be extended.
  • Use Case: When adding a new persisted schema field, follow the checklist to create an idempotent migration, register it in the correct steps array, and run the focused test plus bunx tsc --noEmit before merging.

Quick Start

Ask the assistant to review a new database migration file against the migration checklist and confirm it is idempotent, registered, and covered by a focused test.

Frequently Asked Questions about vellum-migration-checklist

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add a database migration in the Vellum Assistant codebase?▼

Add a new file under assistant/src/persistence/migrations/, make it idempotent and safe to retry, register it in the migrationSteps array in steps.ts, and add a focused db-*migration*.test.ts test. Never reorder existing migrations.

How do I create a workspace migration for file format changes?▼

Add a new numbered file under assistant/src/workspace/migrations/, append it to WORKSPACE_MIGRATIONS in registry.ts, keep it idempotent, and add a workspace-migration-*.test.ts test. Never reuse or reorder existing migration IDs.

Can I delete or reorder old migration files?▼

No. Migrations are append-only and must never be deleted, reordered, or have their IDs reused, even when their logic becomes obsolete. Existing installs depend on the original ordering.

Can I add new release-notes workspace migrations?▼

No. The update-bulletin feature was removed and the historical release-notes migration set is frozen by workspace-release-notes-feature-flag-guard.test.ts. Design an explicit on-demand surfacing mechanism instead.

How do I verify a migration change before merging?▼

Run the focused migration test with bun test for the relevant test file, then run bunx tsc --noEmit when migration exports, schema types, or registry wiring changed.

Related Skills

Explore More Software Engineering Skills→
adamrdrewadamrdrew
1

create-memory

Create memory.md with a standard header and entries section when missing.

Community
Basic
mprycmpryc

run-e2e-tests

Automates end-to-end testing for OADP projects including setup, execution, and analysis.

Community
Advanced
ConsiliencyConsiliency
8

schema-alignment

Detect drift between database schemas and ORM models in Python and TypeScript projects.

Official
Advanced
reliant-labsreliant-labs
4

db

Manage database schema changes through append-only SQL migrations.

Official
Intermediate