README

Robo commands and tasks for Drupal

Doc pages are at https://thinkshout.github.io/robo-drupal/index.html

Classes are listed at https://thinkshout.github.io/robo-drupal/class_think_shout_1_1_robo_drupal_1_1_tasks.html

Update information

If you update to the 3.x release, you will need to rerun robo configure to set the TS_PROD_BRANCH variable (--prod-branch=main). This allows you to use a branch name for production deployments that is not the default. If you do not specify a production branch, it will default to "main".

Once you have set a production branch, you can create a branch with that name from your current production branch, push the new branch up to github, and delete the old branch. In some cases, you may need to change the default branch in github (although that is normally "develop"). You may want to review open pull requests as well, and notify other developers on the project to update their local repositories by pulling down the new branch.

Installation

1. In your projects' composer.json file, under "extra" -> "drupal-scaffold" -> "allowed-packages" add "thinkshout/robo-drupal"
2. Require robo-drupal for dev environments: composer require --dev thinkshout/robo-drupal -W
3. Update the values in .env.dist to match your site: TERMINUS_SITE (example: mysite), TS_PROJECT (example: mysite), and DRUSH_OPTIONS_URI (example: web.mysite.localhost)
4. Run robo configure. This should create a .env file based on your .env.dist file.
5. Test out the configuration above by pulling down the live database:

robo pull:config # Makes a database backup and pulls it locally.
robo install # Builds your local database - you can pull from "local"

1. In your project's ".gitignore" file, add the ".env" file at the bottom, like so (you might just need to uncomment):

# Ignore generated config
.env