Workspace 6.21.5
CreateInstaller

Creates an installer; a package or executable containing the attached PackageItems. The operation will create a different type of item depending on which platform it is executed on. On Linux, it will create an RPM package (Debian distributions are not supported by this operation). On Windows, it will create a Windows installer executable using the NullSoft Scriptable Install System, which provides step-by-step installation instructions to the user. On MacOS, it creates a .PKG file containd within a .DMG image, which will install each of the required components.

  • Default label: "Create install package"
  • Member of plug-in: Package
  • Catalogue path: Packaging
Inputs:
Run packagerboolIf enabled, the operation will build a package. If disabled, it will do nothing.
Package output directoryQString

Package nameQStringThe platform-independent name of the package. Used to generate the filename of the installer / package. The name cannot not contain spaces.
Package display nameQString

Package install areaQString

SummaryQStringWritten summary of what the package is installing.
Menu group nameQStringName of the menu group in the Start or Applications menu.
Menu group descriptionQString

Menu group iconQString

Major versionint

Minor versionint

Patch versionint

Version suffixQStringSet an optional version suffix such as '-RC1' for release candidates
Package release numberQStringSet to 0 or empty string if the release number is already part of the version number
VendorQStringThe Id of the Vendor; the party distributing the executable.
Vendor domainQStringThe domain name of the Vendor.
Include vendor in package nameCSIRO::Package::CreateInstaller::VendorPackageNameLocationIf enabled, the Vendor name will be included in the package filename.
Include vendor domain in package nameCSIRO::Package::CreateInstaller::VendorPackageNameLocation

Clean up temporary filesboolGenerating a package can create many temporary files. If this is enabled, the operation will clean up after itself.
RPM descriptionQStringThe description of the package as displayed in RPM package managers on Linux.
RPM license typeQStringThe license type, as displayed in RPM package managers on Linux.
RelocatableboolWhether or not the output package is able to be installed to alternative locations.
Strip symbolsboolIf enabled, debugging symbols will be stripped from libraries and executables in the RPM package.
Include xdg utils in RPM packageboolThe xdg-utils package is a set of simple scripts that provide basic desktop integration functions for any Free Desktop, such as linux. This input allows the package to optionally contain the xdg-utils scripts.
Auto-add dependenciesbool

RPM install prefixQString

RPM dependenciesArrayQString

RPM providesArrayQString

RPM preinstall scriptQString

RPM postinstall scriptQString

RPM preuninstall scriptQString

RPM postuninstall scriptQString

Windows license textQString

Windows install prefixQString

Include Visual Studio runtime librariesbool

Visual Studio runtimes install directoryQString

NSIS preinstall commandsQString

NSIS postinstall commandsQString

NSIS preuninstall commandsQString

Windows package name with VS versionboolAdd VS version to the package name.
Append with-symbols label to package nameboolAdd 'with-symbols' label to the package name, if option PACK_PDB had been defined for Workspace build.
Mac welcome textQString

Mac readme textQString

Mac license textQString

Mac install prefixQString

Mac preinstall scriptQString

Mac postinstall scriptQString

Mac signing identity nameQStringThe name of the signing identity to use to sign the final package. If left blank, the package will not be signed. This will make it more difficult for users to install the package on some versions of OSX.
Mac signing keychainQStringThe name of the keychain that contains the signing identity specified by the mac signing identity input. If left blank, the default keychain will be used when signing.
Package itemsArrayCSIRO::Package::PackageItem

Package PluginConnectorbool

Run PluginConnectorbool

Outputs:
PackageQString

Contents of CMake fileQString