ReleaseScriptsTask

MMO\admin\tasks · 1 symbol · generated 27 Oct 2026

class

ReleaseScriptsTask

Run the release scripts a target has not run yet, once the new release is live: what a version needs done on each site besides its code and its database patches -- roles to create (php admin.php developer roles), files to move, a cache to rebuild, an index to fill.

class MMO\admin\tasks\ReleaseScriptsTask extends MMO\admin\classes\aDeployTask

Namespace: MMO\admin\tasks
Extends: aDeployTask

A script is a file of [`$folder`](https://mmoframework.fr/en/documentation/mmo.admin/php/tasks/ReleaseScriptsTask.md#releasescriptstask-folder) (`scripts/release/` by default, on the deploying machine: the folder never ships), its id its filename. It runs **once per target**, as the database patches do: the journal records it (`Deployment::$scripts`, [`Journal::getRanScripts`](https://mmoframework.fr/en/documentation/mmo.admin/php/helpers/Journal.md#journal-getranscripts)), and a target that has run it never runs it again -- a new target runs them all, so a script must be idempotent (« create the role when it is missing »). They run in natural order of their names: prefix them with the version or the date (`4.3.0-01-developer-roles.sh`, `2026-10-13-01-developer-roles.sh`). - `.php` runs with `php`, `.sh` with `bash`; it is sent into the live release (`current/.release-scripts/`), run from the release's folder, then removed. It is given `MMO_TARGET`, `MMO_RELEASE`, `MMO_VERSION` and `MMO_URL`. - A script that fails stops the ones after it (they may assume it ran) and **fails the release**: the release is rolled back -- the previous code, the database snapshot -- and the script stays to run. Unless its name says `.optional.` (`4.3.0-02-reindex.optional.php`): its failure is then said, the release stays, the scripts after it run (nothing may count on an optional one), and it runs again at the next release (or `php scripts/admin.php release-scripts --targets=...`). It runs after [`ActivateTask`](https://mmoframework.fr/en/documentation/mmo.admin/php/tasks/ActivateTask.md#activatetask): a script runs against the code it is written for, and the site answers already.

Index

	OPTIONAL	what makes a script's failure a warning rather than the release's failure
	folder
	pattern
	apply($context)
	getDescription()
	getName()
	getPending($context, $excludeRan)
	isNeeded($context)
	IsOptional($id) static
	plan($context)
	verify($context)
	__construct($folder, $pattern)

Constants1

OPTIONAL

what makes a script's failure a warning rather than the release's failure

const OPTIONAL = '.optional.'

Properties2

folder

protected string $folder

Type: string

pattern

protected string $pattern

Type: string

Methods9

apply($context)

ReleaseScriptsTask.php:60

function apply(MMO\admin\helpers\Context $context): void

$context	Context
returns	void

getDescription()

ReleaseScriptsTask.php:44

function getDescription(): string

returns

string

getName()

ReleaseScriptsTask.php:42

function getName(): string

returns

string

getPending($context, $excludeRan)

ReleaseScriptsTask.php:120

function getPending(MMO\admin\helpers\Context $context, bool $excludeRan = true): array

$context	Context
$excludeRan = true	bool	leave out the scripts the journal says ran
returns	array	string> id => filename, in natural order

isNeeded($context)

ReleaseScriptsTask.php:46

function isNeeded(MMO\admin\helpers\Context $context): bool

$context	Context
returns	bool

IsOptional($id)

staticReleaseScriptsTask.php:111

static function IsOptional(string $id): bool

$id	string
returns	bool	whether a script's failure only warns (`OPTIONAL`)

plan($context)

ReleaseScriptsTask.php:50

function plan(MMO\admin\helpers\Context $context): array

$context	Context
returns	array

verify($context)

ReleaseScriptsTask.php:102

function verify(MMO\admin\helpers\Context $context): array

$context	Context
returns	array

__construct($folder, $pattern)

ReleaseScriptsTask.php:35

function __construct( string $folder = '{root}/scripts/release', string $pattern = '/\\.(php|sh)$/' )

$folder = '{root}/scripts/release'	string
$pattern = '/\\.(php\|sh)$/'	string

Inherited members (37)

Constants	Declared by	Description
`ALERT`	iLogLevel	Alert: Action must be taken immediately.
`ALL`	iLogLevel	Mask for all
`ALL_PLUS`	iLogLevel	debug everything
`BACKTRACE`	iLogLevel
`CRITICAL`	iLogLevel	Critical: Critical conditions.
`DEBUG`	iLogLevel	Debug: Detailed debug information.
`DEEP`	iLogLevel	debug everything with arguments
`EMERGENCY`	iLogLevel	Emergency: System is unusable.
`ERROR`	iLogLevel	Error: Runtime errors that do not require immediate action but should typically be logged and monitored.
`ERROR_PLUS`	iLogLevel	Mask for all error
`FATAL`	iLogLevel	Mask for all fatal error
`INFO`	iLogLevel	Info: Interesting events.
`INFO_PLUS`	iLogLevel	Mask for all errors/warning/notices/info
`MEMORY`	iLogLevel	include backtrace object
`NOTICE`	iLogLevel	Notice: Normal but significant events.
`NOTICE_PLUS`	iLogLevel	Mask for all errors/warning/notices/info
`TRACE`	iLogLevel	include backtrace as origins
`WARNING`	iLogLevel	Warning: Exceptional occurrences that are not errors.
`WARNING_PLUS`	iLogLevel	Mask for all errors and warnings

	Properties	Declared by	Description
	`verbosity`	aDeployTask

Methods	Declared by	Description
`alert($message, $context)`	aDeployTask	Action must be taken immediately.
`backtraces($message, $context)`	aDeployTask	Force-log a message at INFO level together with a full stack trace/memory snapshot (`iLogLevel::BACKTRACE`), bypassing the verbosity mask entirely (any non-zero verbosity is enough to trigger it).
`critical($message, $context)`	aDeployTask	Critical conditions. No-op if CRITICAL is currently filtered out by the verbosity mask.
`debug($message, $context)`	aDeployTask	Detailed debug information.
`debugName()`	aDeployTask
`emergency($message, $context)`	aDeployTask	System is unusable. No-op if EMERGENCY is currently filtered out by the verbosity mask.
`error($message, $context)`	aDeployTask	Runtime errors that do not require immediate action but should typically be logged and monitored.
`getVerbosity()`	aDeployTask
`info($message, $context)`	aDeployTask	Interesting events. No-op if INFO is currently filtered out by the verbosity mask.
`isChange()`	aDeployTask	Whether running this task CHANGES anything.
`isRollbackCritical()`	aDeployTask
`log($level, $message, $context)`	aDeployTask	Logs with an arbitrary level.
`notice($message, $context)`	aDeployTask	Normal but significant events.
`rollback($context)`	aDeployTask	Undo this task. Called by the runner, in reverse order, for every task already applied when a later one failed.
`setVerbosity($verb)`	aDeployTask	Set the current verbosity mask, replacing whatever it was before.
`testVerbosity($level)`	aDeployTask	Test whether a given level (or set of levels) is currently enabled by this instance's verbosity mask.
`warning($message, $context)`	aDeployTask	Exceptional occurrences that are not errors.