Task Runner

PHP task runner based on Robo, focused on extensibility.

Quick references:

• Installation
• Configuration
• Built-in commands
• Expose custom commands as YAML configuration
• Expose custom commands as PHP classes

Installation

Install it with Composer:

$ composer require openeuropa/task-runner

After installation run ./vendor/bin/run for a list of available commands.

Configuration

Execution of Task Runner commands can be controlled in two ways:

1. By setting arguments and options when running a command.
2. By customizing default values in a local runner.yml.dist configuration file, which can be selectively overridden by providing an extra runner.yml.

A list of default values, with a brief explanation, can be found at the default runner.yml.

Built-in commands

The Task Runner comes with the following built-in commands:

Command	Description
changelog:generate	Generate a changelog for the current project based on its GitHub issues and pull requests
drupal:site-install	Install a target Drupal site using default configuration values and/or CLI options
drupal:site-pre-install	Run Drupal pre-install commands as listed under the drupal.pre_install property
drupal:site-post-install	Run Drupal post-install commands as listed under the drupal.post_install property
drupal:settings-setup	Setup default Drupal settings file by appending values specified at drupal.settings
drupal:drush-setup	Setup Drush 8 and 9 configuration files
release:create-archive	Create and archive a release for the current project

Run ./vendor/bin/run help [command-name] for more information about each command's capabilities.

Expose custom commands as YAML configuration

The Task Runner allows you to expose new commands by just listing its tasks under the commands: property in runner.yml.dist/runner.yml.

For example, the following YAML portion will expose two commands, drupal:site-setup and setup:behat:

commands:
  drupal:site-setup:
    - { task: "chmod", file: "${drupal.root}/sites", permissions: 0774, recursive: true }
    - { task: "symlink", from: "../../custom/modules", to: "${drupal.root}/modules/custom" }
    - { task: "symlink", from: "../../custom/themes", to: "${drupal.root}/themes/custom" }
    - { task: "run", command: "drupal:drush-setup" }
    - { task: "run", command: "drupal:settings-setup" }
    - { task: "run", command: "setup:behat" }
    - "./vendor/bin/drush --root=$(pwd)/${drupal.root} cr"
  setup:behat:
    - { task: "process", source: "behat.yml.dist", destination: "behat.yml" }

Commands can reference each-other, allowing for complex scenarios to be implemented with relative ease.

At the moment the following tasks are supported (optional argument default values in parenthesis):

Task	Task	Arguments
mkdir	taskFilesystemStack()	dir, mode (0777)
touch	taskFilesystemStack()	file, time (current time), atime (current time)
copy	taskFilesystemStack()	from, to, force (false)
chmod	taskFilesystemStack()	file, permissions, umask (0000), recursive (false)
chgrp	taskFilesystemStack()	file, group, recursive (false)
chown	taskFilesystemStack()	file, user, recursive (false)
remove	taskFilesystemStack()	file
rename	taskFilesystemStack()	from, to, force (false)
symlink	taskFilesystemStack()	from, to, copyOnWindows (false)
mirror	taskFilesystemStack()	from, to
process	taskProcessConfigFile()	from, to
run	taskExec()	command (will run ./vendor/bin/run [command])

Tasks provided as plain-text strings will be executed as is in the current working directory.

Expose custom commands as PHP classes

More complex commands can be provided by creating Task Runner command classes within your project's PSR-4 namespace.

For example, given you have the following PSR-4 namespace in your composer.json:

{
    "autoload": {
        "psr-4": {
            "My\\Project\\": "./src/"
        }
    }
}

Then you can expose extra commands by creating one or more classes under ./src/TaskRunner/Commands, as shown in the example below:

<?php

namespace My\Project\TaskRunner\Commands;

use OpenEuropa\TaskRunner\Commands\AbstractCommands;

/**
 * Class MyCustomCommands
 *
 * @package My\Project\TaskRunner\Commands
 */
class MyCustomCommands extends AbstractCommands
{
    /**
     * @command my-project:command-one
     */
    public function commandOne() { }

    /**
     * @command my-project:command-two
     */
    public function commandTwo() { }
}

After doing that remember to refresh your local autoloader by running composer dump-autoload.

You can now access your new commands via the Task Runner main executable:

$ ./vendor/bin/run
OpenEuropa Task Runner

Available commands:
 ...
 my-project
  my-project:command-four
  my-project:command-one

NOTE: It is mandatory to place your command classes under ./src/TaskRunner/Commands, otherwise the Task Runner will not register them at startup.

Even if not mandatory it is recommended for your command classes to extend OpenEuropa\TaskRunner\Commands\AbstractCommands.

For more details on how to expose custom commands please refer to the main Robo documentation.