Processor PlistReader

PlistReader

Description

('Extracts values from top-level keys in a plist file, and ', 'assigns to arbitrary output variables. This behavior is ', 'different from other processors that pre-define all their ', "possible output variables. As it is often used for versioning, it defaults to extracting 'CFBundleShortVersionString' to ", "'version'. This can be used as a replacement for both the ", 'AppDmgVersioner and Versioner processors.')

Input Variables

• plist_keys:
  • required: False
  • description: ('Dictionary of plist values to query. Key names ', 'should match a top-level key to read. Values ', 'should be the desired output variable name. ', 'Defaults to: ', "{'CFBundleShortVersionString': 'version'}")
• info_path:
  • required: True
  • description: ('Path to a plist to be read. If a path to a bundle ', '(ie. a .app) is given, its Info.plist will be found and used. ', 'If the path is a folder, it will be searched and the first ', 'found bundle will be used. The path can also be a .dmg, ', 'or contain a .dmg file and the file will be mounted.')

Output Variables

• plist_reader_output_variables:
  • description: ("Output variables per 'plist_keys' supplied as ", 'input. Note that this output variable is used as both a ', 'placeholder for documentation and for auditing purposes. ', 'One should use the actual named output variables as given ', "as values to 'plist_keys' to refer to the output of this ", 'processor.')