Octo

Nested types and modules

TypeDescription
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.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.deleteReleases(setParams)
Signature: setParams:(DeleteReleasesOptions -> DeleteReleasesOptions) -> unit

Deletes a range of releases.

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

Deploys releases that have already been created.

Octo.listEnvironments(setParams)
Signature: setParams:(Options -> Options) -> unit

Lists all environments.

Octo.push(setParams)
Signature: setParams:(PushOptions -> PushOptions) -> unit

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