Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/consolidation/robo
Modern task runner for PHP
https://github.com/consolidation/robo
Last synced: 3 days ago
JSON representation
Modern task runner for PHP
- Host: GitHub
- URL: https://github.com/consolidation/robo
- Owner: consolidation
- License: other
- Created: 2014-01-23T20:47:44.000Z (almost 11 years ago)
- Default Branch: 5.x
- Last Pushed: 2024-10-22T13:19:40.000Z (21 days ago)
- Last Synced: 2024-10-29T21:59:58.766Z (13 days ago)
- Language: PHP
- Homepage: http://robo.li
- Size: 19.5 MB
- Stars: 2,660
- Watchers: 81
- Forks: 304
- Open Issues: 180
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# RoboTask
**Modern and simple PHP task runner** inspired by Gulp and Rake aimed to automate common tasks:
[](https://gitter.im/consolidation/Robo?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://packagist.org/packages/consolidation/robo)
[](https://packagist.org/packages/consolidation/robo)
[](https://packagist.org/packages/consolidation/robo)
[](https://github.com/consolidation/robo/actions)
[](https://scrutinizer-ci.com/g/consolidation/robo/?branch=master)
[](https://codecov.io/gh/consolidation/robo)
[](https://packagist.org/packages/consolidation/robo)
* 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](https://github.com/consolidation/robo/tree/5.x) | Stable | 6 - 7 | 3 | 2 - 3 | 8.2 - 8.3 |
| [4.x](https://github.com/consolidation/robo/tree/4.x) | Stable | 6 | 3 | 2 - 3 | 8.0 - 8.3 |
| [3.x](https://github.com/consolidation/robo/tree/3.x) | Not supported | 4 - 6 | 3 | 1 - 2 | 7.1 - 8.1 |
| [2.x](https://github.com/consolidation/robo/tree/2.x) | Not supported | 4 - 5 | 2 | 1 - 2 | 7.1 - 7.4 |
| [1.x](https://github.com/consolidation/robo/tree/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.
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.
## Installing
### Phar
[Download robo.phar >](https://robo.li/robo.phar)
```
wget https://robo.li/robo.phar
```
To install globally put `robo.phar` in `/usr/bin`. (`/usr/local/bin/` in OSX 10.11+)
```
chmod +x robo.phar && sudo mv robo.phar /usr/bin/robo
```
OSX 10.11+
```
chmod +x robo.phar && sudo mv robo.phar /usr/local/bin/robo
```
Now you can use it simply via `robo`.
### 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.
## Examples
The best way to learn Robo by example is to take a look into [its own RoboFile](https://github.com/consolidation/Robo/blob/2.x/RoboFile.php)
or [RoboFile of Codeception project](https://github.com/Codeception/Codeception/blob/2.4/RoboFile.php). There are also some basic example commands in `examples/RoboFile.php`.
Here are some snippets from them:
---
Run acceptance test with local server and selenium server started.
``` php
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();
}
}
```
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"
```
Using `watch` task so you can use it for running tests or building assets.
``` php
collectionBuilder($io)->taskWatch()->monitor('composer.json', function() use ($io) {
$this->collectionBuilder($io)->taskComposerUpdate()->run();
})->run();
}
}
```
---
Cleaning logs and cache
``` php
collectionBuilder($io)->taskCleanDir([
'app/cache',
'app/logs'
])->run();
$this->collectionBuilder($io)->taskDeleteDir([
'web/assets/tmp_uploads',
])->run();
}
}
```
This task cleans `app/cache` and `app/logs` dirs (ignoring .gitignore and .gitkeep files)
Can be executed by running:
```
robo clean
```
----
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](https://packagist.org/?type=robo-tasks).
## Credits
Follow [@robo_php](https://twitter.com/robo_php) for updates.
Brought to you by [Consolidation Team](https://github.com/orgs/consolidation/people) and our [awesome contributors](https://github.com/consolidation/Robo/graphs/contributors).
## License
[MIT](https://github.com/consolidation/Robo/blob/3.x/LICENSE)