Global variables

Global variables control actions across each phase of the Commerce deployment process: build, deploy, and post-deploy. Because global variables impact every phase, you must set them in the global stage of the .magento.env.yaml file:

stage:
  global:
    GLOBAL_VARIABLE_NAME: value

For more information about customizing the build and deploy process:

• Deployment configuration
• Deployment process

ENABLE_EVENTING

• Default-Not set
• Version—Adobe Commerce 2.4.5 and later

When set to true, enables cron to run message queue consumers. Adobe I/O Events for Adobe Commerce use message queues to expedite the delivery of critical events.

Adobe recommends that you also add the CRON_CONSUMERS_RUNNER variable to the deploy stage of the .magento.env.yaml file with cron_run set to true.

The following example shows a fully configured ENABLE_EVENTING variable.

stage:
  global:
    ENABLE_EVENTING: true
  deploy:
    CRON_CONSUMERS_RUNNER:
      cron_run: true
      max_messages: 0
      consumers: []

ENABLE_WEBHOOKS

• Default-Not set
• Version—Adobe Commerce 2.4.4 and later

When set to true, enables Commerce webhooks. The webhook runs on an external endpoint, such as an App Builder runtime action or a third-party inventory management system. The Webhooks Guide describes this feature in detail.

stage:
  global:
    ENABLE_WEBHOOKS: true

MIN_LOGGING_LEVEL

• Default—Not set
• Version—Adobe Commerce 2.1.4 and later

Overrides the minimum logging level for all output streams without changing the code, which helps when troubleshooting problems with deployment. For example, if your deployment fails, you can use this variable to increase the logging granularity globally. See Log levels. The min_level value in Logging handlers overwrites this setting.

stage:
  global:
    MIN_LOGGING_LEVEL: debug

SCD_ON_DEMAND

• Default—Not set
• Version—Adobe Commerce 2.1.4 and later

Enable generation of static content when requested by a user (SCD). Static content on demand is ideal for the development and testing workflow, because it decreases the deployment time.

Pre-loading the cache using the post_deploy hook reduces site downtime. The cache warming is available only for Pro projects that contain Staging and Production environments in the Project Web Interface and for Starter projects. Add the SCD_ON_DEMAND environment variable to the global stage in the .magento.env.yaml file:

stage:
  global:
    SCD_ON_DEMAND: true

The SCD_ON_DEMAND variable skips the SCD in both phases (build and deploy), clears the pub/static and var/view_preprocessed folders, and writes the following to the app/etc/env.php file:

return array(
   ...
   'static_content_on_demand_in_production' => 1,
   ...
);

SCD_MAX_EXECUTION_TIME

• Default—Not set
• Version—Adobe Commerce 2.2.0 and later

Allows you to increase the maximum expected execution time for static content deployment.

By default, Adobe Commerce sets the maximum expected execution to 900 seconds, but in some scenarios you might need more time to complete the static content deployment for a Cloud project.

stage:
  global:
    SCD_MAX_EXECUTION_TIME: 3600

SCD_NO_PARENT

• Default—Not set
• Version—Adobe Commerce 2.4.2 and later

Set to true to prevent generating static content for parent themes during the build and deployment phases. When this option is set to true, less static content is generated, which improves your overall build and deployment times.

stage:
  global:
    SCD_NO_PARENT: true

SCD_USE_BALER

• Default—Not set
• Version—Adobe Commerce 2.3.0 and later

Baler is a module that scans your generated JavaScript code and creates an optimized JavaScript bundle. Deploying the optimized bundle to your site can reduce the number of network requests when loading your site and improve page load times.

Set to true to run Baler after performing static content deployment.

stage:
  build:
    SCD_USE_BALER: true

SKIP_HTML_MINIFICATION

• Default:
  • true—for ece-tools 2002.0.13 and later
  • false—for earlier versions of ece-tools
• Version—Adobe Commerce 2.1.4 and later

Enables or disables copying static view files to the <magento_root>/init/ directory at the end of the build stage. If set to true, files are not copied and HTML minification is available on request. Set this value to true to reduce downtime when deploying to Staging and Production environments.

• false—Copies the view_preprocessed directory to the <magento_root>/init/ directory at the end of the build phase, and restores the directory in the <magento_root>/var directory at the beginning of the deploy phase.
• true—Enables on-demand HTML minification; does not copy the <magento_root>var/view_preprocessed to the <magento_root>/init/ directory at the end of the build phase.

Add the SKIP_HTML_MINIFICATION environment variable to the global stage in the .magento.env.yaml file:

stage:
  global:
    SKIP_HTML_MINIFICATION: true

X_FRAME_CONFIGURATION

• Default—Not set
• Version—Adobe Commerce 2.1.4 and later

Use the X_FRAME_CONFIGURATION variable to change the X-Frame-Options header configuration for your Adobe Commerce site. This configuration controls how the browser renders a page in a <frame>, <iframe>, or <object>. Use one of the following options:

• DENY—Page cannot be displayed in a frame.
• SAMEORIGIN—(The default Adobe Commerce setting.) Page can be displayed only in a frame on the same origin as the page itself.

Add the X_FRAME_CONFIGURATION environment variable to the global stage in the .magento.env.yaml file:

stage:
  global:
    X_FRAME_CONFIGURATION: SAMEORIGIN