FAKE - F# Make - A DSL for build tasks and more FAKE
6.0.0

Lookig for older versions of the documentation, pre FAKE v6? See 

v5.fake.build

Octo Module

Octo module contains tasks to interact with Octo.exe tool

Types

Type Description

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

Option type for pushing packages

ServerOptions

Octo.exe server options

Functions and values

Function or value Description

Octo.createRelease setParams

Full Usage: Octo.createRelease setParams

Parameters:

Creates a release.

setParams : CreateReleaseOptions -> CreateReleaseOptions

The create release parameters

Octo.createReleaseAndDeploy setReleaseParams setDeployParams

Full Usage: Octo.createReleaseAndDeploy setReleaseParams setDeployParams

Parameters:

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

setReleaseParams : CreateReleaseOptions -> CreateReleaseOptions

The release parameters

setDeployParams : DeployReleaseOptions -> DeployReleaseOptions option

The deploy parameters

Octo.createReleaseAndDeployWithExitCode setReleaseParams setDeployParams

Full Usage: Octo.createReleaseAndDeployWithExitCode setReleaseParams setDeployParams

Parameters:
Returns: int

Creates a release, and optionally deploys it to one or more environments and returns the exit code.

setReleaseParams : CreateReleaseOptions -> CreateReleaseOptions

The release parameters

setDeployParams : DeployReleaseOptions -> DeployReleaseOptions option

The deploy parameters

Returns: int

Octo.createReleaseWithExitCode setParams

Full Usage: Octo.createReleaseWithExitCode setParams

Parameters:
Returns: int

Creates a release and returns the exit code.

setParams : CreateReleaseOptions -> CreateReleaseOptions

The create release parameters

Returns: int

Octo.deleteReleases setParams

Full Usage: Octo.deleteReleases setParams

Parameters:

Deletes a range of releases.

setParams : DeleteReleasesOptions -> DeleteReleasesOptions

The releases to delete parameters

Octo.deleteReleasesWithExitCode setParams

Full Usage: Octo.deleteReleasesWithExitCode setParams

Parameters:
Returns: int

Deletes a range of releases and returns the exit code.

setParams : DeleteReleasesOptions -> DeleteReleasesOptions

The delete release parameters

Returns: int

Octo.deployRelease setParams

Full Usage: Octo.deployRelease setParams

Parameters:

Deploys releases that have already been created.

setParams : DeployReleaseOptions -> DeployReleaseOptions

The release deployment parameters

Octo.deployReleaseWithExitCode setParams

Full Usage: Octo.deployReleaseWithExitCode setParams

Parameters:
Returns: int

Deploys releases that have already been created and returns the exit code.

setParams : DeployReleaseOptions -> DeployReleaseOptions

The release parameters

Returns: int

Octo.listEnvironments setParams

Full Usage: Octo.listEnvironments setParams

Parameters:
    setParams : Options -> Options - The environments to list parameters

Lists all environments.

setParams : Options -> Options

The environments to list parameters

Octo.listEnvironmentsWithExitCode setParams

Full Usage: Octo.listEnvironmentsWithExitCode setParams

Parameters:
Returns: int

Lists all environments and returns the exit code.

setParams : Options -> Options

The Octo tool parameters

Returns: int

Octo.push setParams

Full Usage: Octo.push setParams

Parameters:

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

setParams : PushOptions -> PushOptions

The push package parameters

Octo.pushWithExitCode setParams

Full Usage: Octo.pushWithExitCode setParams

Parameters:
Returns: int

Pushes one or more packages to the Octopus built-in repository and returns the exit code.

setParams : PushOptions -> PushOptions

The push parameters

Returns: int