Note: This is the migration API reference for FAKE 5. The new (modularized) API documentation can be found here. If the API is already migrated you can check here if exists in a module. More information regarding the migration can be found here

OBSOLETE

FAKE0001 Use the Fake.Tools.Octo module instead

OctoTools

Contains tasks which can be used for automated deployment via Octopus Deploy. There is also a tutorial about the Octopus deployment helper available.

Nested types and modules

TypeDescription
CreateReleaseOptions
OBSOLETE

FAKE0001 Use the Fake.Tools.Octo module instead

Options for creating a new release

DeleteReleaseOptions
OBSOLETE

FAKE0001 Use the Fake.Tools.Octo module instead

Options for deleting a range of releases in a project

DeployReleaseOptions
OBSOLETE

FAKE0001 Use the Fake.Tools.Octo module instead

Options for deploying a release to an environment

OctoCommand
OBSOLETE

FAKE0001 Use the Fake.Tools.Octo module instead

Option type for selecting one command

OctoParams
OBSOLETE

FAKE0001 Use the Fake.Tools.Octo module instead

Complete Octo.exe CLI params

OctoServerOptions
OBSOLETE

FAKE0001 Use the Fake.Tools.Octo module instead

Octo.exe server options

PushOptions
OBSOLETE

FAKE0001 Use the Fake.Tools.Octo module instead

Functions and values

Function or valueDescription
commandLine(command)
Signature: command:OctoCommand -> string
Attributes:
[<Obsolete("FAKE0001 Use the Fake.Tools.Octo module instead")>]
OBSOLETE

FAKE0001 Use the Fake.Tools.Octo module instead

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

deleteOptions
Signature: DeleteReleaseOptions
Attributes:
[<Obsolete("FAKE0001 Use the Fake.Tools.Octo module instead")>]
OBSOLETE

FAKE0001 Use the Fake.Tools.Octo module instead

Default options for 'DeleteReleases'

deployOptions
Signature: DeployReleaseOptions
Attributes:
[<Obsolete("FAKE0001 Use the Fake.Tools.Octo module instead")>]
OBSOLETE

FAKE0001 Use the Fake.Tools.Octo module instead

Default options for 'DeployRelease'

Octo(setParams)
Signature: setParams:(OctoParams -> OctoParams) -> unit
Attributes:
[<Obsolete("FAKE0001 Use the Fake.Tools.Octo module instead")>]
OBSOLETE

FAKE0001 Use the Fake.Tools.Octo module instead

This task calls the Octo.exe CLI. See Octopus-Tools for more details.

Parameters

  • setParams - Function used to overwrite the OctoTools default parameters.
octoParams
Signature: OctoParams
Attributes:
[<Obsolete("FAKE0001 Use the Fake.Tools.Octo module instead")>]
OBSOLETE

FAKE0001 Use the Fake.Tools.Octo module instead

Default parameters to call octo.exe.

releaseOptions
Signature: CreateReleaseOptions
Attributes:
[<Obsolete("FAKE0001 Use the Fake.Tools.Octo module instead")>]
OBSOLETE

FAKE0001 Use the Fake.Tools.Octo module instead

Default options for 'CreateRelease'

serverCommandLineForTracing(opts)
Signature: opts:OctoServerOptions -> string
Attributes:
[<Obsolete("FAKE0001 Use the Fake.Tools.Octo module instead")>]
OBSOLETE

FAKE0001 Use the Fake.Tools.Octo module instead

serverOptions
Signature: OctoServerOptions
Attributes:
[<Obsolete("FAKE0001 Use the Fake.Tools.Octo module instead")>]
OBSOLETE

FAKE0001 Use the Fake.Tools.Octo module instead

Default server options.