The Code Studio pipeline is ready-for-use and out-of-the-box. Additionally, it can be customized to fit the needs of different projects.
You can use environment variables to:
Set custom or specific parameters for the CI/CD pipeline
For example, you can set an environment variable so that the pipeline is aware of the PHP version in your repository.
You can also add environment variables through the .gitlab-ci.yml file.
For example:
include:
- project: 'acquia/standard-template'
file:
- '/gitlab-ci/Auto-DevOps.acquia.gitlab-ci.yml'
variables:
- ACQUIA_JOBS_CREATE_CDE: "true" You can also edit environment variables through the .gitlab-ci.yml file.
For example:
include:
- project: 'acquia/standard-template'
file:
- '/gitlab-ci/Auto-DevOps.acquia.gitlab-ci.yml'
variables:
- ACQUIA_JOBS_CREATE_CDE: "false"| Environment variable name | Description | Default value |
|---|---|---|
| Enables or disables the Test Drupal job of of the . |
| Environment variable name | Description | Default value |
|---|---|---|
ACQUIA_TASKS_SETUP_DRUPAL_STRATEGY | Determines if Code Studio does either of the following during the Test Drupal stage and the Automatic Updates stage:
|
When set to true, the Test Drupal job executes.
true |
ACQUIA_JOBS_CREATE_CDE | Enables or disables the Acquia Continuous Delivery Environment (CDE) creation during the Deploy Drupal stage. When set to | true |
ACQUIA_JOBS_DEPRECATED_UPDATE | Enables or disables the Deprecated Code Update job of Automatic Updates. When set to | true |
ACQUIA_JOBS_COMPOSER_UPDATE | Enables or disables the Composer Update job of Automatic Updates. When set to | true |
ACQUIA_JOBS_VALIDATE_CODE | Enables or disables the Validate Code Structure job of the Auto DevOps pipeline. When set to | true |
ACQUIA_TASKS_SETUP_DRUPAL | Ensures that the Drupal site is set up when the
If you enable the Drupal setup, Code Studio runs | false |
ACQUIA_TASKS_SETUP_DRUPAL_CONFIG_IMPORT | Imports Drupal configuration after the database is created or copied. This is applicable only when | true |
ACQUIA_JOBS_CREATE_TAG_ARTIFACT | Enables Code Studio to push all tags to Cloud Platform during the Deploy Drupal stage. After Code Studio pushes the tagged release to Cloud Platform, you can select it on any of your Cloud Platform environments. | true |
ACQUIA_JOBS_DEPLOY_TAG_ARTIFACT | Deploys the newly created tag to the specified Cloud Platform environment during the Deploy Drupal stage automatically. This variable is applicable only when To specify the Cloud Platform environment where tags must deploy to, set the For more information about how to enable deploy tags, see Enabling deploy tags in Code Studio. | false |
ACQUIA_TASKS_PHPUNIT | Enables or disables the PHPUnit task during the Test Drupal job of the Auto DevOps pipeline. When set to | true |
ACQUIA_TASKS_PHPCS | Enables or disables the PHP Code Sniffer task during the Test Drupal job of the Auto DevOps pipeline. When set to | true |
ACQUIA_TASKS_PHPSTAN | Enables or disables the PHPStan task during the Test Drupal job of the Auto DevOps pipeline. When set to | true |
ACQUIA_TASKS_DRUTINY | Enables or disables the Drutiny task during the Test Drupal job of the Auto DevOps pipeline. When set to | false |
The valid values are install or sync.
install, you can assign a Drupal profile using the ACQUIA_TASKS_SETUP_DRUPAL_PROFILE environment variable. If you do not select any profile, Code Studio selects the the minimal profile. If ACQUIA_TASKS_SETUP_DRUPAL_CONFIG_IMPORT is set to true, Code Studio imports your Drupal configuration to the new database.sync, you can set the ACQUIA_CLOUD_SOURCE_ENVIRONMENT_ID and the ACQUIA_CLOUD_SOURCE_DATABASE_NAME environment variables. If you do not set these environment variables, Code Studio syncs your first production database. If ACQUIA_TASKS_SETUP_DRUPAL_CONFIG_IMPORT is set to true, Code Studio imports your Drupal configuration imports to the database after the database is copied.install |
ACQUIA_TASKS_SETUP_DRUPAL_PROFILE | Specifies the install profile that Code Studio uses to create the Drupal database during the Test Drupal stage and the Automatic Updates stage. This variable is applicable only when ACQUIA_TASKS_SETUP_DRUPAL is set to true, and ACQUIA_TASKS_SETUP_DRUPAL_STRATEGY is set to install. | minimal |
SAST_EXCLUDED_PATHS | Excludes vulnerabilities from output based on the paths. This is a vulnerability filter from GitLab. All Acquia-managed SAST scan jobs for Drupal run as part of the Test Drupal stage of the Auto DevOps pipeline. | spec, test, tests, tmp, node_modules, vendor, contrib, core |
ACQUIA_CLOUD_SOURCE_DATABASE_NAME | Fetches the database name at run time. This variable is used when the database name is not found. | null |
ACQUIA_CLOUD_SOURCE_ENVIRONMENT_ID | Fetches the environment name at run time. This variable is used when an environment ID variable is not found. To automatically deploy tags to an environment other than production, set the variable to the environment ID of your target environment. For more information, see Deploy Drupal stage. | null |
PHP_VERSION | Fetches the PHP version that the project is running. The valid values are 8.2, 8.3, 8.4 and 8.5. This is a mandatory variable. | 8.3 |
ACQUIA_CODEBASE_UUID | The UUID of the codebase to be used for the Code Studio project. | unique identifier for the Acquia codebase |
ACQUIA_APPLICATION_UUID | The UUID of the application to be used for the Code Studio project. | unique identifier for the Acquia application |
MYSQL_VERSION | Specifies the MySQL version to be used in the project Valid values: 5.7 and 8.0. This is a mandatory variable. | 8.0(New project),5.7 (Existing project) |
If this content did not answer your questions, try searching or contacting our support team for further assistance.
When set to true, the Test Drupal job executes.
true |
ACQUIA_JOBS_CREATE_CDE | Enables or disables the Acquia Continuous Delivery Environment (CDE) creation during the Deploy Drupal stage. When set to | true |
ACQUIA_JOBS_DEPRECATED_UPDATE | Enables or disables the Deprecated Code Update job of Automatic Updates. When set to | true |
ACQUIA_JOBS_COMPOSER_UPDATE | Enables or disables the Composer Update job of Automatic Updates. When set to | true |
ACQUIA_JOBS_VALIDATE_CODE | Enables or disables the Validate Code Structure job of the Auto DevOps pipeline. When set to | true |
ACQUIA_TASKS_SETUP_DRUPAL | Ensures that the Drupal site is set up when the
If you enable the Drupal setup, Code Studio runs | false |
ACQUIA_TASKS_SETUP_DRUPAL_CONFIG_IMPORT | Imports Drupal configuration after the database is created or copied. This is applicable only when | true |
ACQUIA_JOBS_CREATE_TAG_ARTIFACT | Enables Code Studio to push all tags to Cloud Platform during the Deploy Drupal stage. After Code Studio pushes the tagged release to Cloud Platform, you can select it on any of your Cloud Platform environments. | true |
ACQUIA_JOBS_DEPLOY_TAG_ARTIFACT | Deploys the newly created tag to the specified Cloud Platform environment during the Deploy Drupal stage automatically. This variable is applicable only when To specify the Cloud Platform environment where tags must deploy to, set the For more information about how to enable deploy tags, see Enabling deploy tags in Code Studio. | false |
ACQUIA_TASKS_PHPUNIT | Enables or disables the PHPUnit task during the Test Drupal job of the Auto DevOps pipeline. When set to | true |
ACQUIA_TASKS_PHPCS | Enables or disables the PHP Code Sniffer task during the Test Drupal job of the Auto DevOps pipeline. When set to | true |
ACQUIA_TASKS_PHPSTAN | Enables or disables the PHPStan task during the Test Drupal job of the Auto DevOps pipeline. When set to | true |
ACQUIA_TASKS_DRUTINY | Enables or disables the Drutiny task during the Test Drupal job of the Auto DevOps pipeline. When set to | false |
The valid values are install or sync.
install, you can assign a Drupal profile using the ACQUIA_TASKS_SETUP_DRUPAL_PROFILE environment variable. If you do not select any profile, Code Studio selects the the minimal profile. If ACQUIA_TASKS_SETUP_DRUPAL_CONFIG_IMPORT is set to true, Code Studio imports your Drupal configuration to the new database.sync, you can set the ACQUIA_CLOUD_SOURCE_ENVIRONMENT_ID and the ACQUIA_CLOUD_SOURCE_DATABASE_NAME environment variables. If you do not set these environment variables, Code Studio syncs your first production database. If ACQUIA_TASKS_SETUP_DRUPAL_CONFIG_IMPORT is set to true, Code Studio imports your Drupal configuration imports to the database after the database is copied.install |
ACQUIA_TASKS_SETUP_DRUPAL_PROFILE | Specifies the install profile that Code Studio uses to create the Drupal database during the Test Drupal stage and the Automatic Updates stage. This variable is applicable only when ACQUIA_TASKS_SETUP_DRUPAL is set to true, and ACQUIA_TASKS_SETUP_DRUPAL_STRATEGY is set to install. | minimal |
SAST_EXCLUDED_PATHS | Excludes vulnerabilities from output based on the paths. This is a vulnerability filter from GitLab. All Acquia-managed SAST scan jobs for Drupal run as part of the Test Drupal stage of the Auto DevOps pipeline. | spec, test, tests, tmp, node_modules, vendor, contrib, core |
ACQUIA_CLOUD_SOURCE_DATABASE_NAME | Fetches the database name at run time. This variable is used when the database name is not found. | null |
ACQUIA_CLOUD_SOURCE_ENVIRONMENT_ID | Fetches the environment name at run time. This variable is used when an environment ID variable is not found. To automatically deploy tags to an environment other than production, set the variable to the environment ID of your target environment. For more information, see Deploy Drupal stage. | null |
PHP_VERSION | Fetches the PHP version that the project is running. The valid values are 8.2, 8.3, 8.4 and 8.5. This is a mandatory variable. | 8.3 |
ACQUIA_CODEBASE_UUID | The UUID of the codebase to be used for the Code Studio project. | unique identifier for the Acquia codebase |
ACQUIA_APPLICATION_UUID | The UUID of the application to be used for the Code Studio project. | unique identifier for the Acquia application |
MYSQL_VERSION | Specifies the MySQL version to be used in the project Valid values: 5.7 and 8.0. This is a mandatory variable. | 8.0(New project),5.7 (Existing project) |
If this content did not answer your questions, try searching or contacting our support team for further assistance.