The project settings tab lets you change the settings attached to your distribution or raw package project such as the name for the distribution or raw package file, the format of the distribution, whether some files or folders should be excluded from the payload, etc.
To access the Project settings tab for a distribution project:
|1||Choose Project > Project|
|2||Click the Settings project tab.|
To access the Project settings tab for a raw package project:
|▪||Click the Project tab.|
The build name is the name under which the package or distribution will be created on disk when you build the project.
Naming conventions and limitations:
By default, the project name is set to the project document file name.
To change the build name:
|▪||Type the new name in the Name text field.|
The build location is the folder on disk where the distribution or package will be created during the build phase. If the last path components of the build location do not exist, they will be created.
By default, the build location is a build folder at the same level as the project.
To change the build location:
|1||Choose Choose from the Action pop-up menu on the right of the Path text field.|
|2||Select or create the folder to use as the build location and click Choose.|
To know more about the reference folder, read the File Reference Style chapter.
By default, the reference folder is set to be the project folder.
To change the reference folder:
|1||Choose Other from the Reference Folder popup button.|
|2||Select or create the folder to use as the reference folder and click Choose.|
To revert the reference folder to its default value:
|1||Hold down the alt key.|
|2||Choose Revert to Default from the Reference Folder popup button.|
There are 2 distribution formats available:
These 2 formats are not equal when it comes to compatibility and features:
|Can be hosted as is on a web server|
To change the distribution format:
|▪||Choose the format from the Format popup button.|
If you want to ensure that a raw package of flat distribution has not been tampered between the time you built it and the time the end user installs it, you can set a certificate to the project.
When you set a certificate, the raw package or flat distribution will get signed during the build phase. You will be asked to enter your administrator password at least once when the signing step is reached. For more information on the build process, check the Building a project chapter.
When a raw package or flat distribution is signed, a certificate or lock icon will be displayed in the title bar of the
You can click on this icon to check the validity of the certificate.
To set a certificate:
|1||Choose Project > Set Certificate|
|2||Select the certificate you want to use.|
When a certificate is set, a certificate widget is sticked to the Project pane:
Caution: Gatekeeper and the Developer ID Installer Certificate
OS X 10.8 and later includes an additional "security" feature, Gatekeeper, that requires packages and flat distributions to be signed. Packages and distributions downloaded from the Internet and that have not been signed may not be allowed to be installed by users depending on Gatekeeper's current settings. Signing the packages and distributions for Gatekeeper requires to use a certificate provided by Apple to paying ADC members.
Caution: macOS Catalina (10.15.x) and Notarization
macOS Catalina and probably later require distributions and packages to be notarized for the end-users to be able to install them by double-clicking them.
To notarize your distributions and packages, you need to:
You can find more information about the notarization process here: Customizing the Notarization Workflow.
To inspect the certificate:
|1||Click the certificate widget.|
|2||When you're finished inspecting the certificate, click OK.|
To remove the certificate:
|1||Choose Project > Remove Certificate|
The purpose of an exclusion is to define which files or folders should be excluded from the payload of packages or the resources folders when a project is built. For instance, the payload of a package may be created with bundles that contains Source Code Management metadata used by Subversion (SVN) or CVS. When the name of a filesystem object matches an exclusion, the object (and its children if any) will not be appended to the payload.
Exclusions are built around a pattern that can be a string or a regular expression. An exclusion can apply to only files, only folders or both of them.
A few standard exclusions are available by default. By default, they are all enabled. You can not remove a standard exclusion from the list but you can disable it if needed. Standard exclusions do not list the pattern they use. Here is a list of what kind of files or folders are excluded by them:
|Standard Exclusion||Excluded files or folders|
|Remove .DS_Store files||Removes |
|Remove .pbdevelopment files||Remove |
|Remove SCM metadata||Remove helper files and folders used by the CVS and SVN Source Code Management systems.|
|Optimize nib files||Remove |
|Remove Resources Disabled folders||Remove |
To add a custom exclusion:
|1||Click the + button.|
|2||Type the pattern the name of a file or folder should match to be excluded in the Pattern column of the new row.|
|3||Click the popup in the Kind column for this row to select if this pattern should be looked only for files, only for folders or for both.|
|4||If the pattern should be interpreted as a regular expression, click the checkbox in the RegEx column for this row.|
To enable or disable an exclusion:
|▪||Click the checkbox in the column to switch the state of the pattern.|
To remove a custom exclusion:
|1||Select the row(s) of the custom exclusion(s) you want to remove.|
|2||Click the - button.|
Advanced options let you set values for settings that are either advanced or not documented.
|Note: Do not change any of these values if you don't know exactly what you're doing.|
The following advanced project options are supported:
|minSpecVersion||The lowest version of the Install framework for which this distribution file is designed.|
|verifiedSpecVersion||The highest version of the Install framework for which this distribution file is designed.|
|maxSpecVersion||The highest version of the Install framework against which this distribution file has been qualified.|
|hostArchitectures (1)||Defines the architectures supported by the distribution.|
|arch (1)||Defines the architectures supported by the distribution for macOS client.|
|arch (1)||Defines the architectures supported by the distribution for OS X server.|
By default, the Advanced Options section is not visible.
To show or hide the Advanced Options section:
|1||Choose Packages > Preferences|
|3||Click the Show Advanced User Options checkbox.|
To change the value of an advanced option:
|▪||Click or double-click the appropriate cell to change the value of the text field or checkbox.|
Adding notes and comments
You can add notes or comments to a project. For instance, you can list the versions of applications installed by the project.
To add or change comments:
|1||Click the Comments project tab.|
|2||Type your notes in the text field.|
|Note: The comments text field supports styled text.|