consolidation/robo

Modern task runner

Saturday, July 28, 2018
by greg.1.anderson
Repository
106 Watchers
2077 Stars
1,718,008 Installations

PHP
231 Dependents
1 Suggesters
256 Forks
106 Open issues
100 Versions
22 % Grown

The README.md

RoboTask

Modern and simple PHP task runner inspired by Gulp and Rake aimed to automate common tasks:, _(*1)

, _(*2)

, _(*3)

writing cross-platform scripts
processing assets (less, sass, minification)
running tests
executing daemons (and workers)
watching filesystem changes
deployment with sftp/ssh/docker

Branches

Branch	Support Level	Symfony	League Container	psr/log	PHP Versions
5.x	Stable	6 - 7	3	2 - 3	8.2 - 8.3
4.x	Stable	6	3	2 - 3	8.0 - 8.3
3.x	Not supported	4 - 6	3	1 - 2	7.1 - 8.1
2.x	Not supported	4 - 5	2	1 - 2	7.1 - 7.4
1.x	Not supported	2 - 4	2	1 - 2	5.5 - 7.4

All versions are roughly compatible; the breaking changes introduced at each major version are fairly minor, and typically only affect classes that are not used by most clients., _(*4)

Note also that Robo 5.x removed consolidation/self-update as a direct dependency. You will need to explicitly add it if you are using it to update your application phar., _(*5)

Installing

Phar

Download robo.phar >, _(*6)

wget https://robo.li/robo.phar

To install globally put robo.phar in /usr/bin. (/usr/local/bin/ in OSX 10.11+), _(*7)

chmod +x robo.phar && sudo mv robo.phar /usr/bin/robo

OSX 10.11+, _(*8)

chmod +x robo.phar && sudo mv robo.phar /usr/local/bin/robo

Now you can use it simply via robo., _(*9)

Composer

Run composer require consolidation/robo:^4
Use vendor/bin/robo to execute Robo tasks.

Usage

All tasks are defined as public methods in RoboFile.php. It can be created by running robo init. All protected methods in traits that start with task prefix are tasks and can be configured and executed in your tasks., _(*10)

Examples

The best way to learn Robo by example is to take a look into its own RoboFile or RoboFile of Codeception project. There are also some basic example commands in examples/RoboFile.php., _(*11)

Here are some snippets from them:, _(*12)

Run acceptance test with local server and selenium server started., _(*13)

``` php <?php, _(*14)

use Robo\Symfony\ConsoleIO;, _(*15)

class RoboFile extends \Robo\Tasks {, _(*16)

function testAcceptance(ConsoleIO $io, $seleniumPath = '~/selenium-server-standalone-2.39.0.jar')
{
   // launches PHP server on port 8000 for web dir
   // server will be executed in background and stopped in the end
   $this->collectionBuilder($io)->taskServer(8000)
        ->background()
        ->dir('web')
        ->run();

   // running Selenium server in background
   $this->collectionBuilder($io)->taskExec('java -jar ' . $seleniumPath)
        ->background()
        ->run();

   // loading Symfony Command and running with passed argument
   $this->collectionBuilder($io)->taskSymfonyCommand(new \Codeception\Command\Run('run'))
        ->arg('suite','acceptance')
        ->run();
}

}, _(*17)


If you execute `robo` you will see this task added to list of available task with name: `test:acceptance`.
To execute it you should run `robo test:acceptance`. You may change path to selenium server by passing new path as a argument:

robo test:acceptance "C:\Downloads\selenium.jar", _(*18)


Using `watch` task so you can use it for running tests or building assets.

``` php
<?php
class RoboFile extends \Robo\Tasks {

    function watchComposer(ConsoleIO $io)
    {
        // when composer.json changes `composer update` will be executed
        $this->collectionBuilder($io)->taskWatch()->monitor('composer.json', function() use ($io) {
            $this->collectionBuilder($io)->taskComposerUpdate()->run();
        })->run();
    }
}

Cleaning logs and cache, _(*19)

``` php <?php class RoboFile extends \Robo\Tasks { public function clean(ConsoleIO $io) { $this->collectionBuilder($io)->taskCleanDir([ 'app/cache', 'app/logs' ])->run();, _(*20)

    $this->collectionBuilder($io)->taskDeleteDir([
        'web/assets/tmp_uploads',
    ])->run();
}

}, _(*21)


This task cleans `app/cache` and `app/logs` dirs (ignoring .gitignore and .gitkeep files)
Can be executed by running:

robo clean, _(*22)


----

Creating Phar archive

``` php
function buildPhar(collectionBuilder $io)
{
    $files = Finder::create()->ignoreVCS(true)->files()->name('*.php')->in(__DIR__);
    $packer = $this->collectionBuilder($io)->taskPackPhar('robo.phar');
    foreach ($files as $file) {
        $packer->addFile($file->getRelativePathname(), $file->getRealPath());
    }
    $packer->addFile('robo','robo')
        ->executable('robo')
        ->run();
}

We need more tasks!

Create your own tasks and send them as Pull Requests or create packages with "type": "robo-tasks" in composer.json on Packagist., _(*23)

Credits

Follow @robo_php for updates., _(*24)

Brought to you by Consolidation Team and our awesome contributors., _(*25)

License

MIT, _(*26)

The Versions

28/07 2018

dev-master

9999999-dev

Modern task runner

library robo

Modern task runner

consolidation/robo

The README.md

RoboTask

Branches

Installing

Phar

Composer

Usage

Examples

We need more tasks!

Credits

License

The Versions

dev-master

The Requires

The Development Requires

by davert

dev-deps/update-0ef6b363

The Requires

The Development Requires

by davert

dev-deps/update-64ac62b7

The Requires

The Development Requires

by davert

dev-deps/update-558c88a8

The Requires

The Development Requires

by davert

dev-deps/update-f911e42d

The Requires

The Development Requires

by davert

dev-deps/update-03b0202b

The Requires

The Development Requires

by davert

dev-site

The Requires

The Development Requires

by davert

1.3.0

The Requires

The Development Requires

by davert

dev-use-overlay-as-is

The Requires

The Development Requires

by davert

dev-version-bump

The Requires

The Development Requires

by davert

dev-env-config

The Requires

The Development Requires

by davert

1.2.4

The Requires

The Development Requires

by davert

dev-improve-starter

The Requires

The Development Requires

by davert

dev-g1a

The Requires

The Development Requires

by davert

dev-deps/update-6ce16509

The Requires

The Development Requires

by davert

dev-deps/update-534ef04c

The Requires

The Development Requires

by davert

dev-deps/update-c4f528f2