Recipe for Wordpress Roots Radicle

[tazeverywhere]

@see https://roots.io/radicle/
Based on laravel recipe, tested and working nicelly.

namespace Deployer;

require_once __DIR__ . '/common.php';

add('recipes', ['wordpress-radicle']);

set('bin/wp-cli', '/bin/wp-cli');

set('shared_dirs', [
    'storage',
    'public/content/uploads',
    'public/content/upgrade',
]);
set('shared_files', [
    '.env',
]);
set('writable_dirs', [
    'public/content/uploads',
    'storage',
    'storage/framework',
    'storage/framework/cache',
    'storage/framework/cache/data',
    'storage/framework/sessions',
    'storage/framework/views',
    'storage/logs',
]);
set('log_files', 'storage/logs/*.log');
set('wordpress_version', function () {
    $result = run('cd {{release_or_current_path}} && {{ bin/wp-cli }} core version');

    return $result ?? 'version not found';
});
set('public_path', 'public');

/**
 * Run an acorn command.
 *
 * Supported options:
 * - 'min' => #.#: The minimum Wordpress version required (included).
 * - 'max' => #.#: The maximum Wordpress version required (included).
 * - 'skipIfNoEnv': Skip and warn the user if `.env` file is inexistant or empty.
 * - 'failIfNoEnv': Fail the command if `.env` file is inexistant or empty.
 * - 'showOutput': Show the output of the command if given.
 *
 * @param string $command The acorn command (with cli options if any).
 * @param array $options The options that define the behaviour of the command.
 * @return callable A function that can be used as a task.
 */
function acorn($command, $options = [])
{
    return function () use ($command, $options) {
        // Ensure the acorn command is available on the current version.
        $versionTooEarly = array_key_exists('min', $options)
            && wordpress_version_compare($options['min'], '<');

        $versionTooLate = array_key_exists('max', $options)
            && wordpress_version_compare($options['max'], '>');

        if ($versionTooEarly || $versionTooLate) {
            return;
        }

        // Ensure we warn or fail when a command relies on the ".env" file.
        if (in_array('failIfNoEnv', $options) && !test('[ -s {{release_or_current_path}}/.env ]')) {
            throw new \Exception('Your .env file is empty! Cannot proceed.');
        }

        if (in_array('skipIfNoEnv', $options) && !test('[ -s {{release_or_current_path}}/.env ]')) {
            warning('Your .env file is empty! Skipping...</>');

            return;
        }

        // Run the acorn command.
        $output = run("cd {{release_or_current_path}} && {{ bin/wp-cli }} acorn $command");

        // Output the results when appropriate.
        if (in_array('showOutput', $options)) {
            writeln("<info>$output</info>");
        }
    };
}

function wordpress_version_compare($version, $comparator)
{
    return version_compare(get('wordpress_version'), $version, $comparator);
}

/*
 * Maintenance mode.
 */

// TODO implement :)
// desc('Puts the application into maintenance / demo mode');
// task('acorn:down', acorn('down', ['showOutput']));

// TODO implement :)
// desc('Brings the application out of maintenance mode');
// task('acorn:up', acorn('up', ['showOutput']));

/*
 * Database and migrations.
 */

desc('Seeds the database with records');
task('acorn:db:seed', acorn('db:seed --force', ['skipIfNoEnv', 'showOutput']));

desc('Runs the database migrations');
task('acorn:migrate', acorn('migrate --force', ['skipIfNoEnv']));

desc('Drops all tables and re-run all migrations');
task('acorn:migrate:fresh', acorn('migrate:fresh --force', ['skipIfNoEnv']));

desc('Rollbacks the last database migration');
task('acorn:migrate:rollback', acorn('migrate:rollback --force', ['skipIfNoEnv', 'showOutput']));

desc('Shows the status of each migration');
task('acorn:migrate:status', acorn('migrate:status', ['skipIfNoEnv', 'showOutput']));

/*
 * Cache and optimizations.
 */

desc('Flushes the application cache');
task('acorn:cache:clear', acorn('cache:clear'));

desc('Creates a cache file for faster configuration loading');
task('acorn:config:cache', acorn('config:cache'));

desc('Removes the configuration cache file');
task('acorn:config:clear', acorn('config:clear'));

desc('Cache the framework bootstrap files');
task('acorn:optimize', acorn('optimize'));

desc('Removes the cached bootstrap files');
task('acorn:optimize:clear', acorn('optimize:clear'));

desc('Creates a route cache file for faster route registration');
task('acorn:route:cache', acorn('route:cache'));

desc('Removes the route cache file');
task('acorn:route:clear', acorn('route:clear'));

desc('Lists all registered routes');
task('acorn:route:list', acorn('route:list', ['showOutput']));

desc('Compiles all of the application\'s Blade templates');
task('acorn:view:cache', acorn('view:cache'));

desc('Clears all compiled view files');
task('acorn:view:clear', acorn('view:clear'));


// Assets task

desc('Build assets localy');
task('assets:build', function () {
    if (!empty(get('assets_path', false))) {
        $assetsPath = trim(get('assets_path'), '/\\');
        runLocally('cd ./' . $assetsPath . ' && ' . get('assets_build', 'npm ci && npm run build'));
    }
    if (!empty(get('assets_dist_path', false))) {
        set('file_upload', [get('assets_dist_path')]);
    }
});

// Upload build assets
desc('Upload assets to deploy path');
task('assets:upload', function () {
    foreach (get('file_upload', []) as $uploadDir) {
        $uploadFolderName = basename($uploadDir);
        $uploadDir = trim($uploadDir, '/\\');
        $uploadFolderPathOneLevelBelow = dirname($uploadDir);
        $compressedFilename = parse($uploadFolderName . '_{{random}}.tar.gz');
        runLocally('cd ./' . $uploadFolderPathOneLevelBelow . ' && tar -zcf ' . $compressedFilename . ' ' . $uploadFolderName);
        $distPath = get('deploy_path') . '/'
            . (test('[ -L {{deploy_path}}/release ]') ? 'release' : 'current') . '/' . $uploadFolderPathOneLevelBelow;
        upload('./' . $uploadFolderPathOneLevelBelow . '/' . $compressedFilename, $distPath);
        runLocally('cd ./' . $uploadFolderPathOneLevelBelow . ' && rm -f ' . $compressedFilename);
        run('cd ' . $distPath . ' && rm -rf ' . $uploadFolderName);
        run('cd ' . $distPath . ' && tar -xf ' . $compressedFilename);
        run('cd ' . $distPath . ' && rm -f ' . $compressedFilename);
    }
});

desc('Deploy assets');
task('deploy:assets', [
    'assets:build',
    'assets:upload',
]);

/**
 * Main deploy task.
 */
desc('Deploys your project');
task('deploy', [
    'deploy:prepare',
    'deploy:vendors',
    'deploy:assets',
    'acorn:config:cache',
    'acorn:route:cache',
    'acorn:view:cache',
    'acorn:migrate',
    'deploy:publish',
]);

[antonmedv]

What about adding to the recipes at PR?

[tazeverywhere]

yes of course I'll do that when I have time.

For the moment I use the recipe from a "deploy" folder in the root of the radicle project, and it can be use with:

• in deploy.php (or yaml) : require __DIR__ . '/deploy/wordpress-radicle.php';
• in wordpres-radicle.php, replace the import of common-php with : require_once './vendor/deployer/deployer/recipe/common.php';

cheers

[davideprevosto]

@tazeverywhere thank you for sharing.