function deploy_drush_command in Deploy - Content Staging 7.3

Same name and namespace in other branches

1. 6 includes/deploy.drush.inc \deploy_drush_command()
2. 7.2 deploy.drush.inc \deploy_drush_command()

Implements hook_drush_command().

File

./deploy.drush.inc, line 11

Provides Drush integration for Deploy.

Code

function deploy_drush_command() {
  $commands = array();
  $commands['deploy-plan'] = array(
    'description' => 'Deploy all content from a plan to all its endpoints.',
    'drupal dependencies' => array(
      'deploy',
    ),
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_FULL,
    'arguments' => array(
      'plan' => 'The plan to deploy.',
    ),
    'examples' => array(
      'drush deploy my_plan' => 'Deploy all content from "my_plan" to all its endpoints.',
    ),
    'aliases' => array(
      'deploy',
      'dp',
    ),
  );
  $commands['deploy-create-plan'] = array(
    'description' => 'Create a new deployment plan.',
    'drupal dependencies' => array(
      'deploy',
    ),
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_FULL,
    'arguments' => array(
      'plan_name' => 'The name of the deployment plan to create.',
    ),
    'required-arguments' => TRUE,
    'options' => array(
      'endpoint' => array(
        'description' => 'The name of the endpoint to deploy to.',
        'example-value' => 'my_endpoint',
        'value' => 'required',
        'required' => TRUE,
      ),
      'aggregator' => array(
        'description' => 'The name of the aggregator plugin to use for the plan.',
        'example-value' => 'DeployAggregatorManaged',
        'value' => 'required',
      ),
      'delete' => array(
        'description' => 'Delete items in the plan after deployment.  Default is 0 (off).',
        'example-value' => '1',
        'value' => 'required',
      ),
      'debug-plan' => array(
        'description' => 'Enable debugging for the plan.  Default is 1 (on).',
        'example-value' => '0',
        'value' => 'required',
      ),
      'overwrite' => array(
        'description' => 'Overwrite the configuration of an existing plan.  Default is 0 (off).',
        'example-value' => '1',
        'value' => 'required',
      ),
    ),
    'examples' => array(
      'drush deploy-create-plan plan_name --endpoint="endpoint-name"' => 'Create a new plan called "plan_name" with the endpoint "endpoint-name".',
    ),
    'aliases' => array(
      'create-plan',
      'dcp',
    ),
  );
  $commands['deploy-delete-plan'] = array(
    'description' => 'Delete a new deployment plan.',
    'drupal dependencies' => array(
      'deploy',
    ),
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_FULL,
    'arguments' => array(
      'plan_name' => 'The name of the deployment plan to delete.',
    ),
    'required-arguments' => TRUE,
    'examples' => array(
      'drush deploy-delete-plan plan_name' => 'Deletes plan called "plan_name".',
    ),
    'aliases' => array(
      'delete-plan',
      'ddp',
    ),
  );
  $commands['deploy-empty-plan'] = array(
    'description' => 'Empty a new deployment plan.',
    'drupal dependencies' => array(
      'deploy',
    ),
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_FULL,
    'arguments' => array(
      'plan_name' => 'The name of the deployment plan to empty.',
    ),
    'required-arguments' => TRUE,
    'examples' => array(
      'drush deploy-empty-plan plan_name' => 'Empties plan called "plan_name".',
    ),
    'aliases' => array(
      'empty-plan',
      'dep',
    ),
  );
  $commands['deploy-flatten-plan'] = array(
    'description' => 'Flattens a new deployment plan.',
    'drupal dependencies' => array(
      'deploy',
    ),
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_FULL,
    'arguments' => array(
      'plan_name' => 'The name of the deployment plan to flatten.',
    ),
    'required-arguments' => TRUE,
    'examples' => array(
      'drush deploy-flatten--plan plan_name' => 'Flattens plan called "plan_name".',
    ),
    'aliases' => array(
      'flatten-plan',
      'dfp',
    ),
  );
  return $commands;
}