keyboardcowboy/drush-denver

Customize modules, variables and permissions for each environment.

Drupal Environment Personalizer

This is a fork of the sandbox project at https://drupal.org/sandbox/bleen18/1696714 which is based on the code by Eric Duran at http://drupal.org/sandbox/ericduran/1154642, _(*1)

The Drupal ENVironemnt personalizER allows you to define blanket settings to apply to your site in one command, such as enabling and disabling modules and setting variables., _(*2)

Installation

Extract this repository into any of Drush's searchable paths for plugins:, _(*3)

1. A .drush folder in your HOME folder., _(*4)

2. Anywhere in a folder tree below an active module on your site., _(*5)

3. /usr/share/drush/commands (configurable), _(*6)

4. In an arbitrary folder specified with the --include option., _(*7)

5. Drupal's /drush or /sites/all/drush folders., _(*8)

See drush topic docs-commands for more details, _(*9)

Configuration

These can be defined in two different files and only apply to the site directory in which they are defined., _(*10)

1. sites/[default|example.com]/drush/env.drushrc.yml, _(*11)

2. sites/[default|example.com]/drush/[dev.]env.drushrc.yml, _(*12)

Like aliases, in the first file you can define multiple aliases keyed on the definition name such as 'dev,' 'stage' or 'chris.' In the second example you can define each environment in a separate file and prefix the filename with the definition name., _(*13)

The definitions are formatted as such:, _(*14)

# Settings for your local environment.
local:
  modules:
    enable:
      - module_name
    disable:
      - module_name

  variables:
    your_var: your_var_value

  permissions:
    RoleName:
      permission_name: 0

  commands:
    command-name:
      alias: @self
      arguments:
        arg1: arg1-val
      options:
        opt1: opt1-val

OR if using a named file like dev.env.drushrc.yml, simply remove the leading item from the list., _(*15)

# Settings for your local environment.
modules:
  enable:
    - module_name
  disable:
    - module_name

variables:
  your_var: your_var_value

permissions:
  RoleName:
    permission_name: 0

commands:
  command-name:
    alias: @self
    arguments:
      arg1: arg1-val
    options:
      opt1: opt1-val

How to Use It

You must be inside a Drupal site directory or use an alias for these commands to work (multisite alias support is coming soon)., _(*16)

1. Create a starter file, _(*17)

   drush env-dir --make, _(*18)

2. See which environments are available., _(*19)

   drush env-list, _(*20)

3. Inspect the contents of an environment definition., _(*21)

   drush env-list [env-name], _(*22)

   Ex. drush env-list dev, _(*23)

4. Run the environment settings for a single definition., _(*24)

   drush env [env-name], _(*25)

   Ex. drush env dev, _(*26)

5. Combine multiple environments. The settings for the latter overriding the former., _(*27)

   drush env [env-name1]+[env-name2], _(*28)

   Ex. drush env dev+chris, _(*29)