Settings

To make this script meet your needs you will need to customize the settings, loaded from YAML files. As of version 1.0 there is no installer so the settings are changed and updated by either using a YAML file or passing options at runtime.

At see http://pyyaml.org/wiki/PyYAMLDocumentation for YAML basics.

Here's how it works:

Settings are built from either YAML files or options passed when Drupdats is run on CLI.

• Settings are loaded in this order:
  • Core settings file, ie drupdates/settings/default.yaml
  • Plugin settings files, ie plugin dir/settings/default.yaml
  • Local settings file in $HOME/.drupdates, ie $HOME/.drupdates/settings.yaml
  • Local settings file in a working directory, ie /.drupdates/settings.yaml
  • Local settings file in a Site Repo, ie /.drupdates/settings.yaml
  • Options passed at runtime, ie $python -m drupdates --workingDir=/opt/
  • Prompts to end user, only if required and not value found above

Settings loaded later take precedence over the same setting loaded earlier, i.e. if it's set as a CLI option it will overwrite anything set in the Core settings or local settings files.

The Core settings file is /drupdates/settings/default.yaml. Additionally, each plugin ships with it's own default.yaml file in its respective settings directory.

Custom Settings file:

You will need to overwrite settings file upon set-up. To do this create a local settings file in $HOME/.drupdates/settings.yaml. Sample settings files can be found below.

Settings Format:

Each setting in the YAML file needs to be a dictionary with the following keys. Each setting should formatted like below or it will be assumed to be blank (ie "") there are notes on what each line means for clarities sake.

Note: Python interprets "" as False.

setting: the name of the setting
  value: required, value of the setting1

Optionally each setting can have other attributes (@see Settings.model()):

setting:
  value:
  prompt: optional, Prompt presented at runtime if setting is null and required
  format: optional, What is the format, supported values: string (default), list, dict
  required: optional, Is the setting required2
  requires: optional, does this setting require another setting

1 Surround with '' if value contains special cahracters. For list of YAML special characters @see http://www.yaml.org/refcard.html.

2 If setting is required and is empty, the end user will be asked for a value.

Sample Files:

• Simpliest Settings file use a manual repository list, work from the "dev" branch, print report to the terminal screen:

  • Simple Settings Gist

• Basic Settings: use a manual repo list, submit deployment ticket to AtTask, print report to the terminal screen:

  • Basic Settings Gist

• Simple Settings commiting to feature branch: Commit changes to a feature branch in remote repo.

  • Feature Branch settings

• One commit per project: Perform one commit for each Drupal project that needs updated.

  • One commit per project

• Basic Make file Settings: use a make file to build the site, manual repo list, submit a deployment ticket to AtTask, print report to the terminal screen:

  • Basic Make file Settings Gist

• Basic Make file and full repo: Use a make file to build the site and ship with the complete repo, manual repo list, submit deployment ticket to AtTask, print report to the terminal screen:

  • Basic Make file and full repo Gist

• Using Stash/Slack: Repo list in Stash user forks, Slack for reporting, use a make file and ship with complete repo, submit deployment ticket to AtTask, print report to the terminal screen, will run only on www.example.com:

  • Using Stash/Slack Gist

Working Directories

Drupdates builds and edits Drupal sites in what is known as the "Working Directory", which is controlled by the workingDir setting. The default working directory setting is:

~/.drupdates/builds

As with any settings this can be overridden in the custom settings file. Further, there are special qualities to note about the working directories.

• You can run Drupdates on only one site in a working directory using the singleSite setting. For example, say you have the following setting for repoDict (short for Repository Dictionary)

repoDict:
  value:
    - drupal:ssh://git@example.com:sites/drupal
    - drupal_two: ssh://git@example.com:sites/drupal_two

If you only wanted to run Drupdates on the "drupal" site above you would pass the following on the command line.

$drupdates --singleSite=drupal

OR set the following in the $HOME/.drupdates/settings.yaml file.

singleSite:
  value: drupal

Multiple Working Directories

• If you are maintaining sites with different configurations, examples include:
• Some use JIRA and others use AtTask
• Some ship with make files and other don't etc...

You can have multiple working directories, each with it's own individual custom settings. The individual working directories would need to have a .drupdates folder with a settings.yaml file.

For example, if you have a working directory at /var/www and /opt/builds each with it's own settings the file structure would look like this:

$HOME/.drupdates/settings.yaml
/var/www/.drupdates/settings.yaml
/opt/builds/.drupdates/settings/yaml

The working directories only have to have settings relevant to those directories in their respective .drupdates/settings.yaml files. In other words they will inherit the settings in the $HOME/drupdates/settings.yaml file.

Note: you still need the default custom settings file at $HOME/.drupdates/settings.yaml, mainly because this is where you set you working directories.