Usher

Usher is intended for use on Chromatic repositories to supplement the use of the Robo PHP task runner. It contains a number of commands to assist in development, builds, and deployments, and can be extended in downstream repos.

• ush·er (verb): to show or guide (someone) somewhere.
• ush·er (noun): American singer, songwriter, businessman, and dancer.

Installation

composer require chromatic/usher

Configuration

1. Create a robo.yml file in the root of your codebase. robo.drupal.example.yml is provided as a starting point for Drupal projects.
2. Create a .sites.config.yml file in the root of your codebase. See .sites.config.example.yml for reference on what can/should be configured.
3. Add the following to your repo's composer.json "scripts" section so that you can call robo easily with composer robo:

"scripts": {
    "robo": "robo --ansi"
}

Commands

robo dev:refresh

The dev:refresh command (often available in downstream repos as composer robo dev:refresh SITENAME) refreshes your local Lando environment which includes:

1. composer install
2. lando start
3. Theme build (robo theme:build).
4. Disabling front-end caches.
5. Downloading the most recent database dump.
6. Importing the database dump.
7. drush deploy
8. Generating a login link.

Extending

You can use this package for the basics and then build upon it. New commands that are relevant only to a single repo should be added to a top-level /robo directory in the project repo. Commands should live at /robo/src/Robo/Plugin/Commands/. Add a new autoload namespace to composer.json so these commands will be detected:

"autoload": {
    "psr-4": {
        "YOURPREFIXRobo\\": "robo/src"
    }
}

Contributing

If you have a new command that would be useful to multiple repositories that use this package, create a new command here under /src/Robo/Plugin/Commands via a pull request.