Tool and Task based on Robo.li to manage Joomla Development and Releases
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src/Tasks
tests
.drone.yml
.gitignore
LICENSE
README.md
RoboFile.php
codeception.yml
composer.json
composer.lock
drone.yml
jorobo.dist.ini
jorobo.ini

README.md

JoRobo (Robo.li tasks for Joomla!)

Latest Stable Version Total Downloads Latest Unstable Version License

Warning: Currently in alpha stage!

Tools and Tasks based on Robo.li for Joomla Extension Development and Releases

Installation (Standalone):

  • composer install
  • configure jorobo.ini
  • vendor/bin/robo

Function overview:

  • vendor/bin/robo build - Builds your extension into an installable Joomla! package or zip file including replacements
  • vendor/bin/robo map - Map (Symlink) your extension into a running Joomla! installation
  • vendor/bin/robo headers - Adds / updates the copyright headers in the source directory (set them in the jorobo.ini)
  • vendor/bin/robo bump - Exchanges the string __DEPLOY_VERSION__ in each file in the source directory with the version number set in the jorobo.ini.

How-to use in your own extension

Do a composer require joomla-projects/jorobo:dev

Make sure your RoboFile.php loads the tasks:

<?php
require 'vendor/autoload.php';

class RoboFile extends \Robo\Tasks
{
	use \Joomla\Jorobo\Tasks\loadTasks;
	..

Then you can use it for your own tasks for example:

$this->taskMap($target)->run();

or

$this->taskBuild($params)->run()

Look at the RoboFile.php in the library root for a sample file.

Usage in your own extension

Directory setup

In order to use JoRobo you should use the following directory structure (it's like the "common" joomla one)

Components

source/administrator/components/com_name/
source/administrator/components/com_name/name.xml
source/administrator/components/com_name/script.php (Optional)
source/components/com_name/
source/administrator/language/en-GB/en-GB.com_name.ini
source/administrator/language/en-GB/en-GB.com_name.sys.ini
source/language/en-GB/en-GB.com_name.ini
source/media/com_name

Modules

source/modules/mod_something
source/media/mod_something
source/language/en-GB/en-GB.mod_something.ini

Plugins

source/plugins/type/name
source/media/plg_type_name
source/administrator/language/en-GB/en-GB.plg_type_name.ini

Extension setup

Either use the sample RoboFile or extend your own with it.