OctopusDeployAliases Class

Summary

Contains functionality related to Octopus Deploy.

In order to use the commands for this alias, include the following in your build.cake file to download and install from nuget.org, or specify the ToolPath within the appropriate settings class: 

#tool "nuget:?package=OctopusTools"

Namespace
Cake.Common.Tools.OctopusDeploy
Base Types
  • object
graph BT Type-->Base0["object"] Type["OctopusDeployAliases"] class Type type-node

Syntax

[CakeAliasCategory("Octopus Deploy")]
public static class OctopusDeployAliases

Attributes

Type Description
CakeAliasCategoryAttribute An attribute used for documentation of alias methods/properties.

Methods

Name Value Summary
OctoCreateRelease(ICakeContext, string, CreateReleaseSettings) void
Creates a release for the specified Octopus Deploy Project.
static
OctoDeployRelease(ICakeContext, string, string, string, string, string, OctopusDeployReleaseDeploymentSettings) void
Deploys the specified already existing release into a specified environment See Octopus Documentation for more details.
static
OctoDeployRelease(ICakeContext, string, string, string, string[], string, OctopusDeployReleaseDeploymentSettings) void
Deploys the specified already existing release into a specified environment See Octopus Documentation for more details.
static
OctoPack(ICakeContext, string, OctopusPackSettings) void
Packs the specified folder into an Octopus Deploy package.
static
OctoPack(ICakeContext, string) void
Packs the specified folder into an Octopus Deploy package.
static
OctoPromoteRelease(ICakeContext, string, string, string, string, string, OctopusDeployPromoteReleaseSettings) void
Promotes the specified already existing release into a specified environment See Octopus Documentation for more details.
static
OctoPush(ICakeContext, string, string, FilePath, OctopusPushSettings) void
Pushes the specified package to the Octopus Deploy repository.
static
OctoPush(ICakeContext, string, string, IEnumerable<FilePath>, OctopusPushSettings) void
Pushes the specified packages to the Octopus Deploy repository.
static

Extension Methods

Name Value Summary
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin