pack
Description
cmf pack is a package creator for the CM MES developments. It puts files and folders in place so that CM Deployment Framework is able to install them.
It is extremely configurable to support a variety of use cases. Most commonly, we use it to pack the developments of CM MES customizations.
Run cmf pack -h to get a list of available arguments and options.
Important
cmf pack comes with preconfigured Steps per PackageType to run during the installation. This pre defined steps are assuming a restrict structure during the installation, this can be disabled using the flag isToSetDefaultSteps:false in your cmfpackage.json.
How it works
When the cmf pack is executed it will search in the working directory, for a cmfpackage.json file, that then is serialized to the CmfPackage this will guarantee that the cmfpackage.json has all the valid and needed fields. Then it will get which is the PackageType, and based on that will generate the package.
IoT packages on MES v10
For MES v10, cmf pack requires a version of @criticalmanufacturing/generator-iot that exposes the standalone cmf-iot-pack command. The generator must be installed in the package or an ancestor's node_modules directory. Node.js must be available on PATH.
The CLI runs the packing engine directly under the same user as the CLI, including root. The source, temporary, and output directories must be writable by that user. The CLI no longer bundles Yeoman for packing.
To migrate an existing project, update its @criticalmanufacturing/generator-iot dependency to a release for your MES version that includes cmf-iot-pack, update the lockfile, and reinstall dependencies in the IoT package directory. In CI, install these dependencies before running cmf pack. A missing standalone command produces an error explaining the required upgrade.
Root package dependencies
For cmfpackagev2 root packages (including feature and IoT roots), cmf pack populates virtual environment dependencies in the in-memory CmfPackage.Dependencies collection using MESVersion from .project-config.json. These dependencies are available throughout packing and are serialized by the normal deployment manifest generator:
Cmf.Environmentis added for all MES versions.CriticalManufacturing.DeploymentMetadatais added only for MES major versions 10 or earlier, and never for App repositories.
Both generated dependencies have mandatory: false. Existing dependencies are matched case-insensitively to avoid duplicates; their versions and flags are preserved when applicable. Deployment metadata is excluded from the in-memory root dependencies for MES 11+ and App repositories, even if present in the source package.
These dependencies do not need to be declared in root templates or source cmfpackage.json files. Packing (including a dry run) updates the in-memory package without rewriting the source file. Without a configured MES version, dependencies are left unchanged.
Usage
cmf pack [options] [<workingDir>]
Arguments
| Name | Description |
|---|---|
<workingDir> |
Working Directory [default: .] |
Options
| Name | Description |
|---|---|
-o, --outputDir <outputDir> |
Output directory for created package [default: Package] |
-f, --force |
Overwrite all packages even if they already exists |
-?, -h, --help |
Show help and usage information |