Octo Module
Octo module contains tasks to interact with Octo.exe tool
Types
| Type | Description |
Options for creating a new release |
|
|
Options for deleting a range of releases in a project |
|
|
Options for deploying a release to an environment |
|
|
Common |
|
|
Option type for pushing packages |
|
|
|
Functions and values
| Function or value | Description |
Full Usage:
Octo.createRelease setParams
Parameters:
CreateReleaseOptions -> CreateReleaseOptions
-
The create release parameters
|
Creates a release.
|
Full Usage:
Octo.createReleaseAndDeploy setReleaseParams setDeployParams
Parameters:
CreateReleaseOptions -> CreateReleaseOptions
-
The release parameters
setDeployParams : DeployReleaseOptions -> DeployReleaseOptions option
-
The deploy parameters
|
Creates a release, and optionally deploys it to one or more environments.
|
Full Usage:
Octo.createReleaseAndDeployWithExitCode setReleaseParams setDeployParams
Parameters:
CreateReleaseOptions -> CreateReleaseOptions
-
The release parameters
setDeployParams : DeployReleaseOptions -> DeployReleaseOptions option
-
The deploy parameters
Returns: int
|
Creates a release, and optionally deploys it to one or more environments and returns the exit code.
|
Full Usage:
Octo.createReleaseWithExitCode setParams
Parameters:
CreateReleaseOptions -> CreateReleaseOptions
-
The create release parameters
Returns: int
|
Creates a release and returns the exit code.
|
Full Usage:
Octo.deleteReleases setParams
Parameters:
DeleteReleasesOptions -> DeleteReleasesOptions
-
The releases to delete parameters
|
Deletes a range of releases.
|
Full Usage:
Octo.deleteReleasesWithExitCode setParams
Parameters:
DeleteReleasesOptions -> DeleteReleasesOptions
-
The delete release parameters
Returns: int
|
Deletes a range of releases and returns the exit code.
|
Full Usage:
Octo.deployRelease setParams
Parameters:
DeployReleaseOptions -> DeployReleaseOptions
-
The release deployment parameters
|
Deploys releases that have already been created.
|
Full Usage:
Octo.deployReleaseWithExitCode setParams
Parameters:
DeployReleaseOptions -> DeployReleaseOptions
-
The release parameters
Returns: int
|
Deploys releases that have already been created and returns the exit code.
|
|
Lists all environments. |
|
Lists all environments and returns the exit code.
|
Full Usage:
Octo.push setParams
Parameters:
PushOptions -> PushOptions
-
The push package parameters
|
Pushes one or more packages to the Octopus built-in repository.
|
Full Usage:
Octo.pushWithExitCode setParams
Parameters:
PushOptions -> PushOptions
-
The push parameters
Returns: int
|
Pushes one or more packages to the Octopus built-in repository and returns the exit code.
|