Octo

Nested types and modules

TypeDescription
Command

Option type for selecting one command

CreateReleaseOptions

Options for creating a new release

DeleteReleasesOptions

Options for deleting a range of releases in a project

DeployReleaseOptions

Options for deploying a release to an environment

Options

Common Octo.exe CLI params

PushOptions
ServerOptions

Octo.exe server options

Functions and values

Function or valueDescription
Octo.commandLine(command)
Signature: command:Command -> string

Maps a command to string input for the octopus tools cli.

Octo.commonOptions
Signature: Options

Default parameters to call octo.exe.

Octo.createRelease(setParams)
Signature: setParams:(CreateReleaseOptions -> CreateReleaseOptions) -> unit

Creates a release.

Octo.createReleaseAndDeploy(...)
Signature: setReleaseParams:(CreateReleaseOptions -> CreateReleaseOptions) -> setDeployParams:(DeployReleaseOptions -> DeployReleaseOptions option) -> unit

Creates a release, and optionally deploys it to one or more environments.

Octo.deleteCommandLine(opts)
Signature: opts:DeleteReleasesOptions -> string
Octo.deleteOptions
Signature: DeleteReleasesOptions

Default options for 'DeleteReleases'

Octo.deleteReleases(setParams)
Signature: setParams:(DeleteReleasesOptions -> DeleteReleasesOptions) -> unit

Deletes a range of releases.

Octo.deployCommandLine(opts)
Signature: opts:DeployReleaseOptions -> string
Octo.deployOptions
Signature: DeployReleaseOptions

Default options for 'DeployRelease'

Octo.deployRelease(setParams)
Signature: setParams:(DeployReleaseOptions -> DeployReleaseOptions) -> unit

Deploys releases that have already been created.

Octo.exec command options
Signature: command:Command -> options:Options -> unit
Octo.flag p b
Signature: p:string -> b:bool -> string
Octo.listEnvironments(setParams)
Signature: setParams:(Options -> Options) -> unit

Lists all environments.

Octo.optionalObjParam p o
Signature: p:string -> o:'?16532 option -> string
Type parameters: '?16532
Octo.optionalStringParam p o
Signature: p:string -> o:string option -> string
Octo.push(setParams)
Signature: setParams:(PushOptions -> PushOptions) -> unit

Pushes one or more packages to the Octopus built-in repository.

Octo.pushCommandLine(opts)
Signature: opts:PushOptions -> string
Octo.pushOptions
Signature: PushOptions

Default options for 'Push'

Octo.releaseCommandLine(opts)
Signature: opts:CreateReleaseOptions -> string
Octo.releaseOptions
Signature: CreateReleaseOptions

Default options for 'CreateRelease'

Octo.serverCommandLine(opts)
Signature: opts:ServerOptions -> string
Octo.serverOptions
Signature: ServerOptions

Default server options.

Octo.stringListParam p os
Signature: p:string -> os:seq<'?16534> -> string
Type parameters: '?16534