Added documentation around PowerShell script

EnableSoftware · May 22, 2015 · d861f76 · d861f76
1 parent 117fae4
commit d861f76
Show file tree

Hide file tree

Showing 6 changed files with 32 additions and 4 deletions.
diff --git a/img/ps-addpowershellstep.png b/img/ps-addpowershellstep.png
diff --git a/img/ps-configurepowershellstep.png b/img/ps-configurepowershellstep.png
diff --git a/source/BuildPowershellScripts/CreateOctopusRelease.ps1 b/source/BuildPowershellScripts/CreateOctopusRelease.ps1
@@ -2,7 +2,7 @@ param(
 	[string]$apiKey,
 	[string]$octopusUrl,
 	[string]$octopusProjectId,
-	[string]$nugetPackageVersions = $null	# needs to be a JSON array of {StepName, Version} objects. If not provided, we'll try to get the latest
+	[string]$nugetPackageVersions	# needs to be a JSON array of {StepName, Version} objects. If not provided, we'll try to get the latest
 )
 $octopusHeader =  @{ "X-Octopus-ApiKey" = $apiKey }
 if (-not $octopusUrl.EndsWith("/")) {$octopusUrl += "/" }
@@ -78,7 +78,7 @@ $templateUrl = $octoProject.Links.DeploymentProcess + "/template"
 $deploymentTemplate = Get-OctopusWebRequest $templateUrl 
 
 # Get package versions
-if ([string]::IsNullOrEmpty($nugetPackageVersions))
+if (-not [string]::IsNullOrEmpty($nugetPackageVersions))
 {
 	$packageVersions = $nugetPackageVersions | ConvertFrom-Json
 }

diff --git a/source/BuildPowershellScripts/README.md b/source/BuildPowershellScripts/README.md
@@ -0,0 +1,28 @@
+Build PowerShell Scripts
+========================
+
+PowerShell Scripts that can be used independently or with [Team Build vNext](http://vsalmdocs.azurewebsites.net/library/vs/alm/build/overview)
+
+[Create Octopus Release](CreateOctopusRelease.ps1)
+----------------------
+Creates a new Release in Octopus Deploy.
+
+### Instructions for use with Team Build vNext:
+
+1. Include the `CreateOctopusRelease.ps1` file in your project or solution
+
+2. Add the *PowerShell* build step to your build definition.
+
+ ![Add PowerShell Build Step](../../img/ps-addpowershellstep.png)
+
+3. Set the *Script filename* field by locating the `CreateOctopusRelease.ps1` file in your repository  
+
+4. Set the following parameters in the *Arguments* field:
+
+ `-apiKey API-LNVK9KXXXXXXXXXXXOAYZS -octopusUrl http://my-octopus-server -octopusProjectId projects-1`
+
+ * **`-apiKey`** - Your API Key (See [documentation](http://docs.octopusdeploy.com/display/OD/How+to+create+an+API+key) for details on how to create an API Key)
+ * **`-octopusUrl`** - The URL that points to your Octopus Deploy server
+ * **`-octopusProjectId`** - The Id of the project you want to create a release for
+
+ ![Configure PowerShell Build Step](../../img/ps-configurepowershellstep.png)
diff --git a/source/CustomBuildSteps/CreateOctopusRelease/Octopus-CreateRelease.ps1 b/source/CustomBuildSteps/CreateOctopusRelease/Octopus-CreateRelease.ps1
@@ -64,7 +64,7 @@ function Get-OctoCredentialParameters($serviceDetails) {
         return "--apiKey=$pwd"
     } else {
         $un = $serviceDetails.Authorization.Parameters.Username
-        return "--user=`"$un`" --pass=`"$pwd`""
+        return "--user=$un --pass=$pwd"
     }
 }
 

diff --git a/source/CustomBuildSteps/README.md b/source/CustomBuildSteps/README.md
@@ -21,7 +21,7 @@ Creates a new Release in Octopus Deploy.
 
  ![Octopus Connected Service](../../img/tfsbuild-connectedservice2.png)
 
- *Note: You can use either username and password, or an API key in the password field. We'll work out which one you're using.*
+ *Note: Currently, you should just put an [API key](http://docs.octopusdeploy.com/display/OD/How+to+create+an+API+key) in the password field. We'll add user/pass soon and work out which one you're using.*
 
 3. Add the *Create Octopus Release* custom build step to your build definition.