Processor FlatPkgUnpacker

FlatPkgUnpacker

NOTE: This page is automatically generated by GitHub Actions when a new release is tagged.
Updates to the information on this page should be submitted as pull requests to the AutoPkg repository. Processors are located here.

Description

Expands a flat package using pkgutil or xar. For xar it also optionally skips extracting the payload.

Input Variables

• flat_pkg_path:
  • required: True
  • description: Path to a flat package. Can point to a globbed path inside a .dmg which will be mounted.
• skip_payload:
  • required: False
  • description: If true, 'Payload' files will be skipped. Defaults to False. Note if this option is used then the files are extracted using xar(1) instead of pkgutil(1). This means components of the package will not be extracted such as scripts.
• destination_path:
  • required: True
  • description: Directory where archive will be unpacked, created if necessary.
• purge_destination:
  • required: False
  • description: Whether the contents of the destination directory will be removed before unpacking. Note that unless skip_payload argument is used the destination directory will be removed as pkgutil requires an empty destination.

Output Variables