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
Options for deploying a release to an environment
| Record Field | Description |
Channel
Signature: string option
|
Channel to use for the new release
|
Common
Signature: Options
|
Common parameters
|
DeploymentCheckSleepCycle
Signature: TimeSpan option
|
Specifies how much time should elapse between deployment status
checks (default: 10 seconds)
|
DeploymentTimeout
Signature: TimeSpan option
|
Specifies maximum time that deployment can take
(default: 10 minutes)
|
DeployTo
Signature: string
|
Environment to deploy to
|
Force
Signature: bool
|
If a project is configured to skip packages with already-installed
versions, override this setting to force re-deployment
|
NoRawLog
Signature: bool
|
Don't print the raw log of failed tasks
|
Progress
Signature: bool
|
Show progress of the deployment.
(Sets --waitfordeployment and --norawlog to true.)
|
Project
Signature: string
|
Name of the project
|
SpecificMachines
Signature: string option
|
A comma-separated list of machine names to target in the
deployed environment. If not specified, all machines in
the environment will be considered.
|
Version
Signature: string
|
Version number of the release to deploy; Specify "latest" for
the latest release
|
WaitForDeployment
Signature: bool
|
Whether to wait synchronously for deployment to finish
|