OctopusDeployReleaseDeployer Class

Summary

The Octopus Deploy Release Deploy runner. This class facilitates deploying existing releases in Octopus Deploy.
Namespace
Cake.Common.Tools.OctopusDeploy
Base Types
graph BT Type-->Base0["OctopusDeployTool<OctopusDeployReleaseDeploymentSettings>"] Base0-->Base1["Tool<OctopusDeployReleaseDeploymentSettings>"] Base1-->Base2["object"] Type["OctopusDeployReleaseDeployer"] class Type type-node

Syntax

public sealed class OctopusDeployReleaseDeployer : 
    OctopusDeployTool<OctopusDeployReleaseDeploymentSettings>

Constructors

Name Summary
OctopusDeployReleaseDeployer(IFileSystem, ICakeEnvironment, IProcessRunner, IToolLocator) Initializes a new instance of the OctopusDeployReleaseDeployer class.

Methods

Name Value Summary
DeployRelease(string, string, string, string[], string, OctopusDeployReleaseDeploymentSettings) void
Requests a deployment of a specified release to an environment.

Extension Methods

Name Value Summary
Dump<OctopusDeployReleaseDeployer>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<OctopusDeployReleaseDeployer>(OctopusDeployReleaseDeployer[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<OctopusDeployReleaseDeployer>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<OctopusDeployReleaseDeployer>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<OctopusDeployReleaseDeployer>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<OctopusDeployReleaseDeployer>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin