4.8. BundleWorks Variables

Table 4.1. Variables available in Bundle hooks

BUNDLE_HOMEThe home directory of the bundle
BUNDLE_NAMEThe name of the bundle (based on directory name)
BUNDLE_VERSIONThe bundle's version (based on directory name)
PLATFORMThe current platform (taken from BUNDLEWORKS_PLATFORM environment variable)
WORK_DIRSet during a deployment action to the deployment's work directory
DEPLOYMENT_HOMESet during a deployment action to the parent of the deployment's work directory
ENVIRONMENT_HOMESet during a deployment action to the environment directory
FROM_VERSIONSet during bw deploy to the version currently deployed
TO_VERSIONSet during bw deploy to the version to be deployed
FROM_BUNDLE_HOMESet during bw deploy to the home of currently deployed bundle
TO_BUNDLE_HOMESet during bw deploy to the home of the bundle to be deployed

Table 4.2. Environment Variables used by BundleWorks

BUNDLEWORKS_BUNDLESList of loaded deployments, colon (:) separated
BUNDLEWORKS_ENVIRONMENTSList of loaded environments, colon (:) separated
BUNDLEWORKS_HOMELocation of the BundleWorks software
BUNDLEWORKS_INCLUDEDirectory contains script functions
BUNDLEWORKS_LOCALELocale to use for displaying messages (only en_US currently available)
BUNDLEWORKS_LOGINName of the user originally logged in (not affected by 'su')
BUNDLEWORKS_PLATFORMString containing platform name (e.g. linux-x86)
BUNDLEWORKS_PLUGINSList of directories searched for plugins, colon (:) separated
BUNDLEWORKS_USERName of the effective user (changed by 'su')
BUNDLEWORKS_WORKLocation of BundleWorks runtime data