Project Bundles

Last updated 4 months ago

Overview

The Project Bundle feature requires the following minimum requirements:

  • AYON Server: Version 1.12.1 or newer.

  • An existing Production Bundle must serve as the base for the project bundle, and it must include the following minimum versions:

    • AYON Launcher: Version 1.4.0 or newer.

    • Core Addon: Version 1.6.0 or newer.

The Project Bundle is an experimental feature that allows you to set specific, customized bundles for individual projects.

This can be extremely useful for long-running projects that might otherwise prevent updates to the main studio production bundle, especially if those updates contain breaking changes. Essentially, a Project Bundle locks the versions of the addons and the launcher for the particular project it is assigned to, ensuring stability and a consistent pipeline.

Creating Project Bundles

Steps for creating a project bundle is almost the same steps mentioned in Create a Bundles section:

  1. Start the Bundle Creation:
    Begin by right-clicking your existing production bundle and selecting Duplicate and Edit.

  2. Configure Bundle Details:
    Set the Bundle name, specify the Launcher version (ensure it is 1.4.0 or higher), disable Development mode (if the toggle is visible), and most importantly, Enable Project bundle.

  3. Set Addon Versions:
    Choose the desired version for each addon.
    Ensure the Core Addon version is 1.6.0 or newer.
    If you set an addon's version to None, the bundle will automatically use the version specified in the current production bundle.

    Addon versions that don't support the Project Bundle feature will inherit the version used by your production bundle. This means the version will continuously mirror the production bundle's version and will automatically update in the project bundle if the production bundle changes.

  4. Finalize Creation:

    Click Create new bundle. Once finished, the new project bundle will be visible with the "project" status.

Using Project Bundles

To set a project bundle for your project, follow these steps:

  1. Access Project Settings:
    In the Project Settings tab (P+P), select your project, and then click the cube icon to assign a project bundle.

  2. Select a Project Bundle:
    A pop-up window will appear where you can select the desired project bundle for your project.

  3. Once the project bundle is set,

    • You'll notice the project bundle name is displayed and the cube icon turns blue.

    • For addons that are locked, they follow the version from the production bundle, and you'll see (Inherited) displayed next to their version number.

Project Bundles Settings

Working with addon settings within your project bundles is the same as working with addon settings within your production or staging bundles. This is because addons within any bundle have default, studio overrides, and project overrides. (For further information about how addon settings work, see How are settings organized?

If the same addon version exists in both your bundle marked for production and your project bundle, changing a setting in the production bundle will be immediately reflected in the project bundle, whether in the studio or project settings. The same principle applies to the Staging bundle.

This occurs because both the project bundle and your bundle marked for production reference the same underlying setting variants (production and staging) for that identical addon version. They look up the same data, meaning a change in one is instantly visible in the other.

Studio Overrides

When managing settings in the Studio Settings tab (S+S) on your server, any changes you make are saved as the production override for the selected addon.

  1. Select the desired Setting Variant.

  2. Select your Project Bundle from the bundle dropdown.

  3. Apply your settings and Save.

Project Overrides

When managing settings in the Project Settings tab (P+P) on your server, any changes you make are saved as a project override for the selected addon.

  1. Ensure the Project Bundle is already assigned to the project.

  2. Select the desired Setting Variant.

  3. Update your settings and Save.

Known Limitations of Project Bundles

  • Updating the Production Bundle: When the Production Bundle is updated with a new addon, that addon's version is propagated to the Project Bundle. This propagated version may not be compatible with the older addons locked by the existing project bundle, see: Project bundles: Disable addon in the project bundle.

  • Addon Compatibility Check: When creating a project bundle, the addon compatibility check only validates against the current production bundle, see: Project bundles: Choose base bundle for addons compatibility check.

  • Development Mode: Project bundles are not supported in Development mode.