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

Open Fake.DotNet instead (FAKE0001 - package: Fake.DotNet.Mage, module: Mage)

MageHelper

Contains helper functions which allow FAKE to call the Manifest Generation and Editing Tool, in short 'MAGE'. The intentional use is the creation of a clickonce application.

Certificates

The MAGE tool wants to sign the manifest using a certificate. It should be clear, that this file is not under source control. On the other hand - you want to be able to run the compile batch on each developer machine. How can we achieve that? In the parameter structure, we use a CertFile property and a TmpCertFile property. Whenever the CertFile was not found, the manifest is signed with a temporary certificate. And the latter one can be shared in the source control.

Nested types and modules

TypeDescription
MageCall
OBSOLETE

Open Fake.DotNet instead (FAKE0001 - package: Fake.TooDotNets.Mage, type: MageCall)

The supported commands of the MAGE tool
MageParams
OBSOLETE

Open Fake.DotNet instead (FAKE0001 - package: Fake.DotNet.Mage, type: MageParams)

Needed information to call MAGE
MageProcessor
OBSOLETE

Open Fake.DotNet instead (FAKE0001 - package: Fake.DotNet.Mage, type: Processor)

These are the supported processor types of the MAGE tool
MageTrustLevels
OBSOLETE

Open Fake.DotNet instead (FAKE0001 - package: Fake.DotNet.Mage, type: TrustLevel)

The level of trust to grant the application on client computers.

Functions and values

Function or valueDescription
mageCall action mp
Signature: action:MageCall -> mp:MageParams -> unit
Attributes:
[<Obsolete("Open Fake.DotNet instead (FAKE0001 - package: Fake.DotNet.Mage, function: call")>]
OBSOLETE

Open Fake.DotNet instead (FAKE0001 - package: Fake.DotNet.Mage, function: call

Execute the MAGE tool. Adds some parameters, dependent on the MAGE command.
MageCreateApp(mp)
Signature: mp:MageParams -> unit
Attributes:
[<Obsolete("Open Fake.DotNet instead (FAKE0001 - package: Fake.DotNet.Mage, function: createApp")>]
OBSOLETE

Open Fake.DotNet instead (FAKE0001 - package: Fake.DotNet.Mage, function: createApp

Encapsulates the MAGE call to create a new application's manifest
MageDeployApp(mp)
Signature: mp:MageParams -> unit
Attributes:
[<Obsolete("Open Fake.DotNet instead (FAKE0001 - package: Fake.DotNet.Mage, function: deployApp")>]
OBSOLETE

Open Fake.DotNet instead (FAKE0001 - package: Fake.DotNet.Mage, function: deployApp

Encapsulates the MAGE call to deploy an application
MageRun(mp)
Signature: mp:MageParams -> unit
Attributes:
[<Obsolete("Open Fake.DotNet instead (FAKE0001 - package: Fake.DotNet.Mage, function: run")>]
OBSOLETE

Open Fake.DotNet instead (FAKE0001 - package: Fake.DotNet.Mage, function: run

Executes a full run of MAGE commands: first, it creates a new manifest file. Then it signs the manifest, deploys the application and finally signs the deployment.
MageSerializeParams action mp
Signature: action:MageCall -> mp:MageParams -> string
Attributes:
[<Obsolete("Open Fake.DotNet instead (FAKE0001 - package: Fake.DotNet.Mage, function: serializeParams (private))")>]
OBSOLETE

Open Fake.DotNet instead (FAKE0001 - package: Fake.DotNet.Mage, function: serializeParams (private))

Convert the parameter structure into command line arguments of MAGE
MageSignDeploy(mp)
Signature: mp:MageParams -> unit
Attributes:
[<Obsolete("Open Fake.DotNet instead (FAKE0001 - package: Fake.DotNet.Mage, function: signDeploy")>]
OBSOLETE

Open Fake.DotNet instead (FAKE0001 - package: Fake.DotNet.Mage, function: signDeploy

Encapsulates the MAGE call to sign the deployment of an application
MageSignManifest(mp)
Signature: mp:MageParams -> unit
Attributes:
[<Obsolete("Open Fake.DotNet instead (FAKE0001 - package: Fake.DotNet.Mage, function: signManifest")>]
OBSOLETE

Open Fake.DotNet instead (FAKE0001 - package: Fake.DotNet.Mage, function: signManifest

Encapsulates the MAGE call to sign an application's manifest
MageUpdateApp(mp)
Signature: mp:MageParams -> unit
Attributes:
[<Obsolete("Open Fake.DotNet instead (FAKE0001 - package: Fake.DotNet.Mage, function: updateApp")>]
OBSOLETE

Open Fake.DotNet instead (FAKE0001 - package: Fake.DotNet.Mage, function: updateApp

Encapsulates the MAGE call to update an existing application's manifest
MageUpdateDeploy(mp)
Signature: mp:MageParams -> unit
Attributes:
[<Obsolete("Open Fake.DotNet instead (FAKE0001 - package: Fake.DotNet.Mage, function: updateDeploy")>]
OBSOLETE

Open Fake.DotNet instead (FAKE0001 - package: Fake.DotNet.Mage, function: updateDeploy