README

Simple handling of cronjobs in your deployment process using the Cron builder library.

Installation

composer require setono/deployer-cron

Usage

The easiest usage is to include the cron recipe which hooks into the default Deployer lifecycle:

<?php
// deploy.php

require_once 'recipe/cron.php';

Deployer parameters

The following Deployer parameters are defined:

Cron builder context

The cron builder context is set to the Deployer configuration parameters. This means you can use variables in your cronjob config files. For example:

<?php
# etc/cronjobs/jobs.php

declare(strict_types=1);

use Setono\CronBuilder\Context;
use Setono\CronBuilder\CronJob;

return static function (Context $context): iterable {
    yield new CronJob('0 0 * * *', '{{ context("bin/php") }} {{ release_path }}/send-report.php', 'Run every day at midnight');

    if ($context->get('stage') === 'prod') {
        yield new CronJob('0 0 * * *', '/usr/bin/php {{ release_path }}/process.php');
    }
};

Notice the usage of bin/php, release_path and stage in the cronjob config file. This is possible because the Deployer configuration is added as context on the cron builder. When the Deployer context key contains a character that would otherwise be interpreted by Twig (e.g. /) you can use the context Twig function to get the value.