OpenParable
Skip to content
← Back to skills

New Migration

Development
new-migration

New Migration is an Agent Skill for development published in the fleetdm/fleet repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Create a new Fleet database migration with timestamp naming, Up function, init registration, and test file.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/fleetdm/fleet/blob/HEAD/.claude/skills/new-migration/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/new-migration, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Create a New Database Migration

Create a migration for: $ARGUMENTS

Process

1. Generate Timestamp and Name

Use make migration name=CamelCaseName if available, or generate manually:

date +%Y%m%d%H%M%S

The migration name should be descriptive CamelCase (e.g., AddRecoveryLockAutoRotateAt, CreateTableSoftwareInstallers).

2. Create Migration File

Location: server/datastore/mysql/migrations/tables/{TIMESTAMP}_{Name}.go

package tables

import "database/sql"

func init() {
	MigrationClient.AddMigration(Up_{TIMESTAMP}, Down_{TIMESTAMP})
}

func Up_{TIMESTAMP}(tx *sql.Tx) error {
	_, err := tx.Exec(`
		-- SQL statement here
	`)
	return err
}

func Down_{TIMESTAMP}(tx *sql.Tx) error {
	return nil
}

3. Create Test File

Location: server/datastore/mysql/migrations/tables/{TIMESTAMP}_{Name}_test.go

package tables

import (
	"testing"

	"github.com/stretchr/testify/require"
)

func TestUp_{TIMESTAMP}(t *testing.T) {
	db := applyUpToPrev(t)

	// Set up test data before migration if needed

	applyNext(t, db)

	// Verify migration applied correctly
	// e.g., check table exists, columns added, data migrated
}

4. Verify

  • Run go build ./server/datastore/mysql/migrations/... to check compilation
  • Run MYSQL_TEST=1 go test -run TestUp_{TIMESTAMP} ./server/datastore/mysql/migrations/tables/ to test the migration

Rules

  • Every migration MUST have a test file
  • Down migrations are always no-ops (return nil) — Fleet doesn't use rollback migrations
  • Never modify existing migration files — create new ones
  • Data migrations go in the data/ subdirectory