Merge pull request #1205 from pantheon-systems/update/0.13.0

Updating to version 0.13.0
pantheon-systems · Sep 15, 2016 · 8dde1f0 · 8dde1f0
2 parents f5a515d + 256c11e
commit 8dde1f0
Show file tree

Hide file tree

Showing 22 changed files with 139 additions and 81 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,7 +1,7 @@
 #Change Log
 All notable changes to this project starting with the 0.6.0 release will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org)
 
-## MASTER
+## [0.13.0] - 2016-09-15
 ### Added
 - New rocket art available using `art rocket`. (#1148)
 

diff --git a/README.md b/README.md
@@ -37,7 +37,7 @@ composer require pantheon-systems/terminus
 
 Run this in this in your terminal client:
 ```bash
-curl https://github.com/pantheon-systems/terminus/releases/download/0.12.0/terminus.phar -L -o /usr/local/bin/terminus && chmod +x /usr/local/bin/terminus
+curl https://github.com/pantheon-systems/terminus/releases/download/0.13.0/terminus.phar -L -o /usr/local/bin/terminus && chmod +x /usr/local/bin/terminus
 ```
 
 ####Installing with [Homebrew](http://brew.sh/)(for Macs)

diff --git a/composer.lock b/composer.lock
diff --git a/config/constants.yml b/config/constants.yml
@@ -7,7 +7,7 @@
 ---
 
 # App
-TERMINUS_VERSION:       '0.12.0'
+TERMINUS_VERSION:       '0.13.0'
 
 # Connectivity
 TERMINUS_HOST:          'terminus.pantheon.io'

diff --git a/docs/Helpers/InputHelper.md b/docs/Helpers/InputHelper.md
@@ -223,6 +223,8 @@
 
 ##### Parameters:
     [array] $arg_options Elements as follow:
+    -array  args    Parameters from the command line
+    -string key     Key to look for in args
     -string message Message to give at prompt
     -mixed  default Returned if user does not select a valid option
 
@@ -242,6 +244,8 @@
 
 ##### Parameters:
     [array] $arg_options Elements as follow:
+    -array  args    Parameters from the command line
+    -string key     Key to look for in args
     -string message Message to give at prompt
     -mixed  default Returned if user does not select a valid option
 

diff --git a/docs/Models/Auth.md b/docs/Models/Auth.md
@@ -6,10 +6,7 @@
 
 ##### Parameters:
     [object] $attributes Attributes of this model
-    [array]  $options    Options to set as $this->key
-
-##### Return:
-    [Auth]
+    [array]  $options    Options with which to configure this model
 
 ---
 

diff --git a/docs/Models/Backup.md b/docs/Models/Backup.md
@@ -1,5 +1,15 @@
 # Terminus\Models\Backup
 
+### __construct
+##### Description:
+    Object constructor
+
+##### Parameters:
+    [object] $attributes Attributes of this model
+    [array]  $options    Options with which to configure this model
+
+---
+
 ### backupIsFinished
 ##### Description:
     Determines whether the backup has been completed or not

diff --git a/docs/Models/Environment.md b/docs/Models/Environment.md
@@ -6,7 +6,7 @@
 
 ##### Parameters:
     [object] $attributes Attributes of this model
-    [array]  $options    Options to set as $this->key
+    [array]  $options    Options with which to configure this model
 
 ---
 
@@ -36,7 +36,7 @@
     Clones database from this environment to another
 
 ##### Parameters:
-    [string] $to_env Environment to clone into
+    [string] $from_env Name of the environment to clone
 
 ##### Return:
     [Workflow]
@@ -48,7 +48,7 @@
     Clones files from this environment to another
 
 ##### Parameters:
-    [string] $to_env Environment to clone into
+    [string] $from_env Name of the environment to clone
 
 ##### Return:
     [Workflow]
@@ -186,6 +186,18 @@
 
 ---
 
+### import
+##### Description:
+    Imports a site archive onto Pantheon
+
+##### Parameters:
+    [string] $url URL of the archive to import
+
+##### Return:
+    [Workflow]
+
+---
+
 ### importFiles
 ##### Description:
     Imports a file archive
@@ -247,7 +259,9 @@
     Enable HTTP Basic Access authentication on the web environment
 
 ##### Parameters:
-    [array] $options Parameters to override defaults
+    [array] $params Elements as follow:
+    -string username
+    -string password
 
 ##### Return:
     [Workflow]
@@ -280,10 +294,12 @@
 
 ### mergeToDev
 ##### Description:
-    Merge code from this Multidev Environment into the Dev Environment
+    Merge code from a multidev environment into the dev environment
 
 ##### Parameters:
     [array] $options Parameters to override defaults
+    -string  from_environment Name of the multidev environment to merge
+    -boolean updatedb         True to update DB with merge
 
 ##### Return:
     [Workflow]

diff --git a/docs/Models/Hostname.md b/docs/Models/Hostname.md
@@ -1,5 +1,15 @@
 # Terminus\Models\Hostname
 
+### __construct
+##### Description:
+    Object constructor
+
+##### Parameters:
+    [object] $attributes Attributes of this model
+    [array]  $options    Options with which to configure this model
+
+---
+
 ### delete
 ##### Description:
     Delete a hostname from an environment
@@ -9,3 +19,12 @@
 
 ---
 
+### serialize
+##### Description:
+    Formats Hostname object into an associative array for output
+
+##### Return:
+    [array] $data associative array of data for output
+
+---
+
diff --git a/docs/Models/MachineToken.md b/docs/Models/MachineToken.md
@@ -1,5 +1,15 @@
 # Terminus\Models\MachineToken
 
+### __construct
+##### Description:
+    Object constructor
+
+##### Parameters:
+    [object] $attributes Attributes of this model
+    [array]  $options    Options with which to configure this model
+
+---
+
 ### delete
 ##### Description:
     Deletes machine token

diff --git a/docs/Models/Organization.md b/docs/Models/Organization.md
@@ -6,10 +6,7 @@
 
 ##### Parameters:
     [object] $attributes Attributes of this model
-    [array]  $options    Options to set as $this->key
-
-##### Return:
-    [Organization]
+    [array]  $options    Options with which to configure this model
 
 ---
 

diff --git a/docs/Models/OrganizationSiteMembership.md b/docs/Models/OrganizationSiteMembership.md
@@ -6,10 +6,7 @@
 
 ##### Parameters:
     [object] $attributes Attributes of this model
-    [array]  $options    Options to set as $this->key
-
-##### Return:
-    [OrganizationSiteMembership]
+    [array]  $options    Options with which to configure this model
 
 ---
 

diff --git a/docs/Models/OrganizationUserMembership.md b/docs/Models/OrganizationUserMembership.md
@@ -6,10 +6,7 @@
 
 ##### Parameters:
     [object] $attributes Attributes of this model
-    [array]  $options    Options to set as $this->key
-
-##### Return:
-    [OrganizationSiteMembership]
+    [array]  $options    Options with which to configure this model
 
 ---
 

diff --git a/docs/Models/Site.md b/docs/Models/Site.md
@@ -6,7 +6,7 @@
 
 ##### Parameters:
     [object] $attributes Attributes of this model
-    [array]  $options    Options to set as $this->key
+    [array]  $options    Options with which to configure this model
 
 ---
 
@@ -27,8 +27,8 @@
     Adds a tag to the site
 
 ##### Parameters:
-    [string] $tag    Name of tag to apply
-    [string] $org_id Organization to add the tag association to
+    [string]       $tag Name of tag to apply
+    [Organization] $org Organization to add the tag association to
 
 ##### Return:
     [array]
@@ -58,6 +58,18 @@
 
 ---
 
+### deployProduct
+##### Description:
+    Creates a new site for migration
+
+##### Parameters:
+    [string[]] $product_id The uuid for the product to deploy.
+
+##### Return:
+    [Workflow]
+
+---
+
 ### completeMigration
 ##### Description:
     Completes a site migration in progress
@@ -235,9 +247,10 @@
 ### getTags
 ##### Description:
     Returns tags from the site/org join
+    TODO: Move these into tags model/collection
 
 ##### Parameters:
-    [string] $org_id UUID of organization site belongs to
+    [Organization] $org UUID of organization site belongs to
 
 ##### Return:
     [string[]]
@@ -275,18 +288,6 @@
 
 ---
 
-### import
-##### Description:
-    Imports a site archive onto Pantheon
-
-##### Parameters:
-    [string] $url URL of the archive to import
-
-##### Return:
-    [Workflow]
-
----
-
 ### info
 ##### Description:
     Load site info
@@ -336,8 +337,8 @@
     Removes a tag to the site
 
 ##### Parameters:
-    [string] $tag    Tag to remove
-    [string] $org_id Organization to remove the tag association from
+    [string]       $tag Tag to remove
+    [Organization] $org Organization to remove the tag association from
 
 ##### Return:
     [array]

diff --git a/docs/Models/SiteOrganizationMembership.md b/docs/Models/SiteOrganizationMembership.md
@@ -1,15 +1,19 @@
 # Terminus\Models\SiteOrganizationMembership
 
-### getOrganization
+### __construct
 ##### Description:
-    Returns organization object within SiteOrganizationMembership object
+    Object constructor
+
+##### Parameters:
+    [object] $attributes Attributes of this model
+    [array]  $options    Options to set as $this->key
 
 ##### Return:
-    [Organization]
+    [SiteUserMembership]
 
 ---
 
-### removeMember
+### delete
 ##### Description:
     Remove membership of organization
 

diff --git a/docs/Models/SiteUserMembership.md b/docs/Models/SiteUserMembership.md
@@ -1,6 +1,19 @@
 # Terminus\Models\SiteUserMembership
 
-### removeMember
+### __construct
+##### Description:
+    Object constructor
+
+##### Parameters:
+    [object] $attributes Attributes of this model
+    [array]  $options    Options with which to configure this model
+
+##### Return:
+    [SiteUserMembership]
+
+---
+
+### delete
 ##### Description:
     Remove membership, either org or user
 

diff --git a/docs/Models/SshKey.md b/docs/Models/SshKey.md
@@ -1,5 +1,15 @@
 # Terminus\Models\SshKey
 
+### __construct
+##### Description:
+    Object constructor
+
+##### Parameters:
+    [object] $attributes Attributes of this model
+    [array]  $options    Options to configure this model
+
+---
+
 ### delete
 ##### Description:
     Deletes a specific SSH key