Runs the Candle tool) on the given WiX script with the given parameters

parameters : Params

Function used to override parameters for candle tool

wixScript : string

The Wix setup script path

Returns: string

Harvests the contents of a Directory for use with Wix using the Heat tool.

setParams : HeatParams -> HeatParams

Function used to manipulate the Heat default parameters.

directory : string

The path to the directory that will be harvested by Heat.

outputFile : string

The output file path given to Heat.

Runs the Light tool on the given WiX script with the given parameters

parameters : Params

Function used to override parameters for light tool

outputFile : string

The output file path

wixObj : string

Uses the WiX tools Candle and Light to create an msi.

setParams : Params -> Params

Function used to manipulate the WiX default parameters.

outputFile : string

The msi output file path (given to Light).

wixScript : string

The path to a WiX script that will be used with Candle.

Example

 Target "BuildSetup" (fun _ ->
         // Copy all important files to the deploy directory
         !! (buildDir + "/**/*.dll")
           ++ (buildDir + "/**/*.exe")
           ++ (buildDir + "/**/*.config")
           |> Copy deployPrepDir

         // replace tags in a template file in order to generate a WiX script
         let ALLFILES = fun _ -> true

         let replacements = [
             "@build.number@",if not isLocalBuild then buildVersion else "0.1.0.0"
             "@product.productcode@",System.Guid.NewGuid().ToString()
             "@HelpFiles@",getFilesAsWiXString helpFiles
             "@ScriptFiles@",getFilesAsWiXString scriptFiles
             "@icons@",getWixDirTag ALLFILES true (directoryInfo(bundledDir @@ "icons"))]

         processTemplates replacements setupFiles

         // run the WiX tools
         WiX (fun p -> {p with ToolDirectory = WiXPath})
             setupFileName
             (setupBuildDir + "Setup.wxs.template")
     )

Use this to attach service controls to your components.

comp : DirectoryComponent

The directory component instance

fileFilter : Component -> bool

The file filter

serviceControls : seq<ServiceControl>

The service controls instance

Returns: DirectoryComponent

components : seq<DirectoryComponent>

fileFilter : Component -> bool

serviceControls : seq<ServiceControl>

Returns: seq<DirectoryComponent>

Use this to attach service installs to your components.

comp : DirectoryComponent

The directory component instance

fileFilter : Component -> bool

The file filter

serviceInstalls : seq<ServiceInstall>

The service installs instance to attach

Returns: DirectoryComponent

components : seq<DirectoryComponent>

fileFilter : Component -> bool

serviceInstalls : seq<ServiceInstall>

Returns: seq<DirectoryComponent>

Creates WiX component with directories and files from the given DirectoryInfo The function will create one component for each file best practice and set the GUID to "*", which will make WiX produce consistent Component Guids if the Component's target path doesn't change. This is vital for major upgrades, since windows installer needs a consistent component guid for tracking each of them. You can use the getComponentIdsFromWiXString function for getting all created component refs and adding them to features.

fileFilter : FileInfo -> bool

The files to filter

directoryInfo : DirectoryInfo

architecture : Architecture

The platform architecture

Returns: seq<DirectoryComponent>

Creates WiX component with directories and files from the given DirectoryInfo The function will create one component for each file best practice and set the GUID to "*", which will make WiX produce consistent Component Guids if the Component's target path doesn't change. This is vital for major upgrades, since windows installer needs a consistent component guid for tracking each of them. The components are embedded into the passed in root directory.

fileFilter : FileInfo -> bool

The files to filter

directoryInfo : DirectoryInfo

The directory information

architecture : Architecture

The platform architecture

Returns: Dir

Creates a WiX directory and component hierarchy from the given DirectoryInfo The function will create one component for each file best practice and set the GUID to "*", which will make WiX produce consistent Component Guids if the Component's target path doesn't change. This is vital for major upgrades, since windows installer needs a consistent component guid for tracking each of them. You can use the getComponentRefs function for getting all created component refs and adding them to features. You can use attachServiceControlToComponents or attachServiceInstallToComponents to attach ServiceControl or ServiceInstall to the directory component hierarchy

fileFilter : FileInfo -> bool

The files to filter

directoryFilter : DirectoryInfo -> bool

The directories to filter

directoryInfo : DirectoryInfo

The directory information

architecture : Architecture

The platform architecture

Returns: seq<DirectoryComponent>

Takes path where script files reside and sets all parameters as defined

wiXPath : string

Pass path where your script is located at. Function will search for all Scripts in that location and fill in parameters

setParams : Script -> Script

Function used to manipulate the WiX default parameters.

Example

 fillInWiXTemplate "" (fun f ->
     {f with
         ProductCode = WiXProductCode
         ProductName = WiXProductName
         Description = projectDescription
         ProductLanguage = WiXProductLanguage
         ProductVersion = WiXProductVersion
         ProductPublisher = WixProductPublisher
         UpgradeGuid = WixProductUpgradeGuid
         UIRefs = uiRef1.ToString() + uiRef2.ToString()
         WiXVariables = wiXLicense.ToString()
         Directories = directories
         DirectoryRefs = directoryrefs
         BuildNumber = "1.0.0"
         Features = rootFeature.ToString()
         CustomActions = action1.ToString() + action2.ToString()
         ActionSequences = actionExecution1.ToString() + actionExecution2.ToString()
     })

Use this for generating component refs

setParams : ComponentRef -> ComponentRef

Function to override the default component ref parameters

Returns: ComponentRef option

Generates a customAction based on the given parameters, use toString on it when embedding it Be careful to make Id unique. FileKey is a reference to a file Id which you added by using getWixDirTag or getWixFileTag Set impersonate to no if your action needs elevated privileges, you should then also set execute as "deferred" ExeCommand are the parameters passed to your executable

setParams : CustomAction -> CustomAction

Function used to manipulate the WiX default parameters.

Returns: CustomAction

Example

 let action = generateCustomAction (fun f ->
         {f with
             Id = "UniqueActionId"
             FileKey = "fi_5"
             Execute = "deferred"
             Impersonate = "no"
             ExeCommand = "install"
             Return = "check"
         })

Generates a custom action execution based on the given parameters, use toString on it when embedding it Condition in sample makes execute only on install

setParams : CustomActionExecution -> CustomActionExecution

Function used to manipulate the WiX default parameters.

Returns: CustomActionExecution

Example

 let actionExecution = generateCustomActionExecution (fun f ->
         {f with
             ActionId = action.Id
             Verb = "After"
             Target = "InstallFiles"
             Condition = "(&" + feature.Id + " = 3) AND NOT (!" + feature.Id + " = 3)"
         })

Generates a feature based on the given parameters, use toString on it when embedding it You can pass other features into InnerContent for making a hierarchy

setParams : Feature -> Feature

Function used to manipulate the WiX default parameters.

Returns: Feature

Example

 let feature = generateFeatureElement (fun f ->
         {f with
             Id = "UniqueName"
             Title = "Title which is shown"
             Level = 1
             Description = "Somewhat longer description"
             Display = "expand"
             InnerContent = [otherFeature1; otherFeature2]
         })

Generates a major upgrade based on the given parameters, use toString on it when embedding it

setParams : MajorUpgrade -> MajorUpgrade

Function used to manipulate the WiX default parameters.

Returns: MajorUpgrade

Example

 let majorUpgradeVersion = generateMajorUpgradeVersion(fun f ->
         {f with
             DowngradeErrorMessage = "A later version is already installed, exiting."
         })

Generates a registry key based on the given parameters, use toString on it when embedding it You can pass other registry keys and values into RegistryKeys or RegistryValues for making a hierarchy

setParams : RegistryKey -> RegistryKey

Function used to manipulate the WiX default parameters.

Returns: RegistryKey

Example

 let key = generateRegistryKey(fun k ->
         {k with
           Id = "KeyId"
           Key = "SomeKey"
           Root = Some RegistryRootType.HKCR
           ForceCreateOnInstall = YesOrNo.Yes
           ForceDeleteOnUninstall = YesOrNo.No
           Keys = someChildKeys
           Values = someChildValues
         })

Generates a registry value based on the given parameters, use toString on it when embedding it

setParams : RegistryValue -> RegistryValue

Function used to manipulate the WiX default parameters.

Returns: RegistryValue

Example

 let registryValue = generateRegistryValue(fun v ->
         {v with
             Id = "asdasd"
             Name = "Something"
             Key = "Somewhere"
             Root = Some RegistryRootType.HKU
             Type = RegistryValueType.Integer
             KeyPath = YesOrNo.No
             Value = "2"
         })

Use this for generating service controls

setParams : ServiceControl -> ServiceControl

Function to override the default service control parameters

Returns: ServiceControl

Use this for generating service installs

setParams : ServiceInstall -> ServiceInstall

Function to override the default service install parameters

Returns: ServiceInstall

Generates a ui ref based on the given parameters, use toString on it when embedding it

setParams : UIRef -> UIRef

Function used to manipulate the WiX default parameters.

Returns: UIRef

Example

 let UIRef = generateUIRef (fun f ->
         {f with
             Id = "WixUI_Mondo"
         })

Generates an upgrade based on the given parameters, use toString on it when embedding it

setParams : Upgrade -> Upgrade

Function used to manipulate the WiX default parameters.

Returns: Upgrade

Example

 let upgrade = generateUpgrade (fun f ->
         {f with
            Id = productUpgradeCode
         })

Generates an upgrade version based on the given parameters, use toString on it when embedding it

setParams : UpgradeVersion -> UpgradeVersion

Function used to manipulate the WiX default parameters.

Returns: UpgradeVersion

Example

 let upgradeVersion = generateUpgradeVersion (fun f ->
         {f with
            Minimum = productVersion
            OnlyDetect = "yes"
         })

Generates WiX Template with specified file name (you can prepend location too) You need to run this once every build an then use fillInWiXScript to replace placeholders

fileName : string

Pass desired fileName for your wiXScript file

Example

 generateWiXScript "Setup.wxs"

Retrieves all component ids from given WiX directory string

wiXString : string

The directory string which was generated by getWixDirTag

Returns: string

Example

 let directoryString = getWixDirTag (fun file -> true) true (DirectoryInfo directoryWithFilesForSetup)
 let componentIds = getComponentIdsFromWiXString directoryString

Get component refs from a directory component hierarchy

elements : seq<DirectoryComponent>

Sequence of directory component elements

Returns: seq<ComponentRef option>

Retrieves the file id of the first file in WiXString, which name matches fileRegex

wiXString : string

The directory string which was generated by getWixDirTag

fileRegex : string

Regex which matches the file name

Returns: string

Example

 let directoryString = getWixDirTag (fun file -> true) true (DirectoryInfo directoryWithFilesForSetup)
 let executableFileId = getFileIdFromWiXString directoryString "\S*.exe"

Creates WiX File tags from the given files

files : seq<string>

The files to get

Returns: string

Creates recursive WiX directory and file tags from the given DirectoryInfo The function will create one component for each file best practice and set the GUID to "*", which will make WiX produce consistent Component Guids if the Component's target path doesn't change. This is vital for major upgrades, since windows installer needs a consistent component guid for tracking each of them. You can use the getComponentIdsFromWiXString function for getting all created component refs and adding them to features.

fileFilter : FileInfo -> bool

The file filter

asSubDir : bool

The sub directory

directoryInfo : DirectoryInfo

The directory information

Returns: string

Take a component string and set "neverOverwrite" Tag This is useful for config files, since they are not replaced on upgrade like that

components : string

The component string

Returns: string