🗓 Setting up omnilight/yii2-scheduling for flexible Craft task scheduling

README.md

📦 Installation

1. Run composer require omnilight/yii2-scheduling to install the scheduling package
2. Setup a config/schedule.php file to house your scheduled processes
3. Modify your config/app.php to include the schedule component details to run the Craft command (instead of yii)
4. Run php craft schedule/run --scheduleFile=@config/schedule.php to process any scheduled operations.

💡 Tip: You likely want to run php craft schedule/run --scheduleFile=@config/schedule.php on a cron job that fires every minute!

🙏 Credits

• The fantastic omnilight/yii2-scheduling package
• Brandon Kelly's mention of how omnilight/yii2-scheduling is used in the craftnet repo

app.php

<?php

use craft\helpers\App;

return [
	'*' => [
		'id' => App::env('APP_ID') ?: 'CraftCMS',
		'modules' => [],
		'bootstrap' => [],
		'components' => [
			'schedule' => [
				'class' => \omnilight\scheduling\Schedule::class,
				'cliScriptName' => 'craft',
			],
		]
	],
];

schedule.php

<?php

/** @var \omnilight\scheduling\Schedule $schedule */

$schedule->command('queue/run')
	->description("Run Queue")
	->everyMinute();

$schedule->command('seomatic/sitemap/generate')
	->description("Generate sitemaps")
	->weekdays()
	->withoutOverlapping()
	->onOneServer();

$schedule->call(function () {
		Craft::$app->getQueue()->push(
			new \modules\guide\jobs\TestJob()
		);
	})
	->description("Run an arbitrary, complex test job")
	->daily()
	->skip(fn() => \USHolidays\Carbon::now()->isHoliday())
	->onOneServer();