Note: This API documentation is for FAKE version 4. The migration API documentation can be found
here. The API documentation for the new fake 5 modules can be found
here
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
Type | Description |
CreateReleaseOptions |
Options for creating a new release |
DeleteReleaseOptions |
Options for deleting a range of releases in a project |
DeployReleaseOptions |
Options for deploying a release to an environment |
OctoCommand |
Option type for selecting one command |
OctoParams |
Complete Octo.exe CLI params |
OctoServerOptions |
Octo.exe server options |
PushOptions |
Functions and values
Function or value | Description |
commandLine(command)
Signature: command:OctoCommand -> string
|
Maps a command to string input for the octopus tools cli. |
deleteOptions
Signature: DeleteReleaseOptions
|
Default options for 'DeleteReleases' |
deployOptions
Signature: DeployReleaseOptions
|
Default options for 'DeployRelease' |
Octo(setParams)
Signature: setParams:(OctoParams -> OctoParams) -> unit
|
This task calls the Octo.exe CLI. See Octopus-Tools for more details. Parameters
|
octoParams
Signature: OctoParams
|
Default parameters to call octo.exe. |
releaseOptions
Signature: CreateReleaseOptions
|
Default options for 'CreateRelease' |
serverCommandLineForTracing(opts)
Signature: opts:OctoServerOptions -> string
|
|
serverOptions
Signature: OctoServerOptions
|
Default server options. |