README

Versioned migration system for Laravel's .env file, similar to database migrations. 🗂️

🇫🇷 Lire en français

🎉 Features

• 🔄 Versioned migrations — manage .env changes just like database migrations
• 📦 Database tracking — tracking table with batches and JSON history
• ⏪ Rollback — revert the last batch of changes
• 📊 Status — view the state of all migrations
• 🧩 Laravel ready — auto-discovery, publishable config, Artisan commands
• 🛡️ Production safe — mandatory confirmation in production (unless --force)
• 🔧 11 methods — set, get, remove, rename, copy, group, block, etc.

📍 Installation

Via Composer (packagist)

composer require dimer47/laravel-env-migrations

🧪 Via a local repository (development)

Add to the host project's composer.json:

{
    "repositories": [
        {
            "type": "path",
            "url": "packages/laravel-env-migrations"
        }
    ],
    "require": {
        "dimer47/laravel-env-migrations": "*"
    }
}

Then:

composer update dimer47/laravel-env-migrations

🔧 Configuration

Publish the package files:

# Publish the config
php artisan vendor:publish --tag=env-migrations-config

# Publish the tracking table migration
php artisan vendor:publish --tag=env-migrations-migrations

# Run the migration
php artisan migrate

⚙️ Configuration options (config/env-migrations.php)

🚀 Quick Start

➕ Create a migration

php artisan env:migrate:make add_redis_configuration

This creates a file in database/env-migrations/ with a ready-to-use template.

✏️ Write a migration

<?php

use Dimer47\EnvMigrations\EnvMigration;

return new class extends EnvMigration
{
    public function getDescription(): string
    {
        return 'Configure Redis for cache and queues';
    }

    public function up(): void
    {
        // Set a variable
        $this->set('CACHE_DRIVER', 'redis');

        // Set only if missing
        $this->setIfMissing('REDIS_HOST', '127.0.0.1');

        // Rename a variable (keeps its position)
        $this->rename('OLD_REDIS_PORT', 'REDIS_PORT');

        // Copy a variable
        $this->copy('REDIS_HOST', 'REDIS_CACHE_HOST');

        // Remove a variable
        $this->remove('DEPRECATED_CACHE_KEY');

        // Group variables together
        $this->ensureGroup([
            'REDIS_HOST' => '127.0.0.1',
            'REDIS_PASSWORD' => 'null',
            'REDIS_PORT' => '6379',
        ], '# Redis Configuration');

        // Insert a group after a reference variable
        $this->ensureGroupAfter('CACHE_DRIVER', [
            'CACHE_PREFIX' => 'myapp',
            'CACHE_TTL' => '3600',
        ]);

        // Append a multi-line block
        $this->appendBlock(<<<'ENV'
# Queue Configuration
QUEUE_CONNECTION=redis
QUEUE_RETRY_AFTER=90
ENV, 'QUEUE_CONNECTION');
    }

    public function down(): void
    {
        $this->set('CACHE_DRIVER', 'file');
        $this->remove('REDIS_CACHE_HOST');
        $this->rename('REDIS_PORT', 'OLD_REDIS_PORT');
        $this->removeBlock('# Queue Configuration', 'QUEUE_RETRY_AFTER');
    }
};

▶️ Run migrations

php artisan env:migrate
php artisan env:migrate --force  # Skip confirmation in production

📊 View status

php artisan env:migrate:status

⏪ Rollback last batch

php artisan env:migrate:rollback
php artisan env:migrate:rollback --force  # Skip confirmation in production

📚 Available methods

🖥️ Artisan Commands

🗄️ Tracking table schema

📄 License

MIT — See LICENSE