Skip to content

Latest commit

 

History

History
165 lines (144 loc) · 6.46 KB

DeployNugetPackage.md

File metadata and controls

165 lines (144 loc) · 6.46 KB

Deploy nuget package (Optimizely DXP)

Take a nuget package from your drop folder in Azure DevOps and upload it to your Optimizely (formerly known as Episerver) DXP project and start a deployment to the targeted environment.
Also support the DirectDeploy function. Introducing "Direct Deploy", a quicker way to deploy to integration using the deployment API!

Spaces in package name(s)

If you send/create packages in the build pipeline that contains spaces. Example "Cool Customer Project.cms.app.20200429.2.nupkg" the script will throw a exception and tell you to update build pipeline to fix that. EpiCloud does not support that package names contains any spaces.

Note: v2 task supports windows/ubuntu/MacOS agents. v1 task only support windows.

<= Back

Parameters

Group: Settings

DXP target environment ClientKey

[string] - required
The DXP API ClientKey for the current environment.
Example: mRgLgE3uCx7RVHc5gzFu1gWtssxcYraL0CvLCMJblkbxweO9
Default value: $(ClientKey)

DXP target environment ClientSecret

[string] - required
The DXP API ClientSecret for the current environment.
Example: mRgLgE3uCx7RVHc5gzFu1gWtssxcYraL0CvLCMJblkbxweO9mRgLgE3uCx7RVHc5gzFu1gWtssxcYraL0CvLCMJblkbxweO9mRgLgE3uCx7RVHc5gzFu1gWtssxcYraL0CvLCMJblkbxweO9
Default value: $(ClientSecret)

Project Id

[string] - required
The DXP project id.
Example: 1921827e-2eca-2fb3-8015-a89f016bacc5
Default value: $(DXP.ProjectId)

Drop path

[string] - required
The path in Azure DevOps where the nuget file(s) is placed. Will try to find the file with the following pattern: "[DropPath]/.[SourceApp]..nupkg". The SourceApp is equal to what you specify for the "SourceApp" parameter. If you specify "cms,commerce", it will try to find both "[DropPath]/.cms..nupkg" and "[DropPath]/.commerce..nupkg" to upload to DXP. Example: $(System.DefaultWorkingDirectory)/_ProjectName-CI/drop
Default value: $(DropPath)

Target environment

[pickList] - required
Specify if you want to deploy to Integration/Preproduction/Production.
Example: Integration
Default value: $(TargetEnvironment)
Options:

  • Integration
  • Preproduction
  • Production
  • ADE1
  • ADE2
  • ADE3

SourceApp

[pickList] - required
Specify which type of application you want to deploy. Will look in the drop folder with the filter .[SourceApp]..nupkg. New in v1.1.0.
If you use "cms,commerce", both nupkg files must be in the same DropPath folder. Example: commerce
Default value: cms
Options:

  • cms
  • commerce
  • cms,commerce

DirectDeploy

[boolean] - required
Specify if you want to do a direct deploy without using slot and warmup.
Example: true
Default value: false

Warm-up URL

[string] Specify if you want to warm-up the web application after deploy. It will request the specified URL and all links found on the page.
If you tests running against the web application that starts after deploy. There could be a problem that the web application is not started and warmed up.
This could/should solve this problem.
Example1: https://dikl06mstr3pe5minte.dxcloud.episerver.net/
Example2: https://dikl06mstr3pe5mprep-slot.dxcloud.episerver.net/
Example3: $(Integration.Url)
Default value: $(Integration.Url)

Use maintenance page

[boolean] - required
Specify if you want to use a maintenance page during the deploy.
Example: true
Default value: false

Zero Downtime Mode

[pickList] - required
The type of smooth deployment you want to use. More information about zero downtime mode
If this parameter is set to empty, no zero downtime deployment will be made. It will be a regular deployment.
Example: ReadOnly
Default value: ``
Options:

  • ''
  • ReadOnly
  • ReadWrite

Group: Timeout

Script timeout (in seconds)

[int] - required
Specify the number of seconds when the task should timeout.
Example: 600
Default value: 1800 (30 minutes)

Group: Benchmark

Run benchmark

[boolean] - required
If you want to send information about your execution, to get benchmark data back.
If you are interested of more benchmark data you can contact Epinova.
By using this function you agree with sending over the following information: Task, TaskVersion, Environment, TargetEnvironment, DxpProjectId, OrganisationId, OrganisationName, ProjectId, ProjectName, Branch, AgentOS, EpiCloudVersion, PowerShellVersion, PowerShellEdition, Elapsed, Result, CmsFileSize, CmsPackageName, CommerceFileSize, CommercePackageName.
Example: true
Default value: false

Group: ErrorHandlingOptions

Run Verbose

[boolean] - required
If you want to run in Verbose mode and see all verbose messages.
Example: true
Default value: false

ErrorActionPreference

[pickList] - required
How the task should handle errors.
Example: 600
Default value: stop Options:

  • Stop: Terminate the action with error.
  • Continue: Display any error message and attempt to continue execution of subsequence commands.
  • SilentlyContinue: Don't display an error message continue to execute subsequent commands.

YAML

Example:

- task: DxpDeployNuGetPackage@2  
    inputs:  
    ClientKey: '$(ClientKey)'  
    ClientSecret: '$(ClientSecret)'  
    ProjectId: '$(DXP.ProjectId)'  
    DropPath: '$(System.DefaultWorkingDirectory)\drop'  
    TargetEnvironment: 'Integration'  
    SourceApp: 'cms'  
    DirectDeploy: true  
    UseMaintenancePage: false  
    Timeout: 1800  
    RunBenchmark: true
    RunVerbose: false

Example with warmup URL:

- task: DxpDeployNuGetPackage@2  
    inputs:  
    ClientKey: '$(ClientKey)'  
    ClientSecret: '$(ClientSecret)'  
    ProjectId: '$(DXP.ProjectId)'  
    DropPath: '$(System.DefaultWorkingDirectory)\drop'  
    TargetEnvironment: 'Integration'  
    SourceApp: 'cms'  
    DirectDeploy: true  
    WarmUpUrl: '$(Integration.Url)'
    UseMaintenancePage: false  
    Timeout: 1800  
    RunBenchmark: true
    RunVerbose: false

<= Back