FAQs and troubleshooting

Common error messages¶

composer require --dev drupal/core-dev                                                                  

Test Drupal:
  before_script:
    - eval $YARN_PACKAGE
    - eval $YARN_PATH

Can the owner of a subscription enable Code Studio?¶

Yes, the owner of a subscription can enable Code Studio.

Can I disable Code Studio from the Cloud Platform user interface?¶

No, you cannot disable Code Studio from the Cloud Platform user interface. To disable your Code Studio subscription, contact Acquia Support.

What versions of Drupal does Code Studio support?¶

Code Studio supports the current Drupal version.

What versions of Node.js does Code Studio support?¶

Code Studio supports Node.js versions 18 and 20.

Why am I seeing a lot of SAST jobs in my Pipeline?¶

Acquia recommends you to not commit contributed dependencies to your repository. Example code for Drupal projects:

git rm -r --cached vendor docroot/core docroot/libraries docroot/modules/contrib docroot/themes/contrib docroot/profiles/contrib node_modules

Add these to your .gitignore. For an example, see acquia/drupal-recommended-project.

How do I install private packages through Composer?¶

Composer provides multiple mechanisms for downloading private packages. Acquia recommends that you store authentication credentials in a project auth.json. For more information, see Authentication in auth.json per project.

This works in Code Studio CI/CD jobs.

I cannot sudo and add packages, move binaries, etc. Why?¶

This is a security restriction on application containers running in the Acquia Kubernetes service.

• If you’re downloading a binary, such as composer.phar or acli.phar (which Acquia has already done for you), you can place it in '$HOME/bin'. The bin folder in the CI user’s home directory is already added to $PATH. It works as long as your binary has an execute permissions set.
• To download a package through `apt` or similar, create a Support ticket.

CDE already exists. What can I do?¶

Error message:

CDE environment with name CDE-xxxx already exists                                                                                

Resolution 1:

If a merge request cannot be declined/merged immediately for some reason, one way is to stop the CDE environment:

1. Log in to Code Studio.
2. Navigate to Environments.
3. Determine the respective environment with the same feature branch name, and stop the environment.
4. Wait for a few minutes for the current pipeline to succeed, and to delete the existing CDE with the same name.
5. Make some minor changes to the current feature’s merge request to re-initiate the pipeline with the CDE creation job.

Resolution 2:

1. Rename the existing CD environment that is pointing to the same source branch from Acquia Cloud.
2. Make some minor changes to the current feature’s merge request to re-initiate the pipeline with CDE creation job.

Is there a limit to the number of projects I can have in Code Studio?¶

No. You can have unlimited projects in Code Studio. However, the Code Studio Auto DevOps pipeline requires your Code Studio project to be linked to an Acquia Cloud application. You can link only one Code Studio project to a given Cloud application.

Does Code Studio work with Cloud IDE?¶

Yes. For instructions on how to set up Code Studio with Cloud IDE, see Setting up a Code Studio project.

For more information, see the following tutorials on dev.acquia.com:

• Setting up a new project in Code Studio using a Cloud IDE
• Connecting Cloud IDE to Code Studio

Can I use an existing application with Code Studio?¶

Yes. Code Studio is compatible with existing applications running Drupal Starter Kits, and the current Drupal version or the current Node.js version.

Can I use a third-party repository with Code Studio?¶

Yes. You can use a third-party repository with Code Studio. For instructions on how to integrate your private repository with Code Studio, see Configuring repository mirroring in Code Studio.

Does Code Studio work with Jira?¶

You can integrate Code Studio with Jira Issues and Jira Development Panel. For more information about setting up the integration, see Integrating Code Studio with Jira.

Can you integrate a Veracode Static analysis with the Code Studio Auto DevOps pipeline¶

Yes. You can integrate a Veracode Static analysis by customizing the standard template for the Drupal Auto DevOps pipeline or by customizing the node template for the Node.js Auto DevOps pipeline.

To customize the Auto DevOps pipeline in Code Studio, see Adding a before_script or after_script to a Code Studio job.

For more information about implementing Veracode Static analysis as part of the pipeline, see GitLab Pipeline Scan Examples.

How many users can I add to Code Studio?¶

With Code Studio entitlements, seats are equivalent to users. The number of seats within your Code Studio subscription is equal to the number of users you can add to your Code Studio instance.

For more questions about Code Studio entitlements, contact your Acquia account team.

Why can I not manage certain seats in Code Studio?¶

If you assign seats through the Code Studio user interface, you might encounter an error while managing such seats. Acquia recommends that you assign seats through the Cloud Platform user interface.

Can I use Code Studio with non-Drupal applications?¶

Code Studio is compatible with Drupal and Node.js applications.

Can I use Code Studio with a Node.js application?¶

Yes. Code Studio is compatible with Drupal or Node.js applications.

Can I customize Code Studio builds?¶

Yes. You can customize Code Studio builds. For instructions, see Customizing a default Code Studio pipeline.

What is a build minute in Code Studio?¶

A build minute is one minute of execution time of a single Code Studio job. Build minutes are the sum of the durations of every job that you execute using Code Studio, including the jobs that run concurrently. For example, if you ran five jobs with each job using ten build minutes, then you used fifty build minutes.

Is there a limit to the build minutes for Code Studio?¶

Yes. Build time is limited to 10k minutes per group per year. 

Can I use my own container image in a Code Studio job?¶

No. With the Auto DevOps pipeline, Acquia maintains the container images used in Code Studio jobs. You can customize jobs, but the base images are selected by Acquia as secure, vetted options that remove overhead for our users.

Can I disable Auto DevOps?¶

Yes, you can disable Auto DevOps.

To disable Auto DevOps:

1. In the left navigation pane, click Settings > CI/CD.
2. Expand the Auto DevOps section.
3. Clear the Default to Auto DevOps pipeline checkbox.

Does Code Studio work with Acquia Site Factory?¶

Yes. The continuous integration (CI) feature of Code Studio is compatible with Acquia Site Factory. However, the continuous delivery (CD) feature of Code Studio is not compatible with Acquia Site Factory.

For more information, see the Code Studio product support scope.

Can I use my own GitLab license with Code Studio?¶

No. External licenses for Gitlab cannot be used with Acquia Code Studio.

How do I enable or execute PHPUnit tests in the Test Drupal stage?¶

Ensure that the ACQUIA_TASKS_PHPUNIT and ACQUIA_TASKS_SETUP_DRUPAL environment variables are set to true.

Do Code Studio runners use specific IP addresses that I can allowlist?¶

Yes. To obtain a list of IP addresses, contact Acquia Support.

Can Code Studio integrate with SonarCube?¶

Yes, Code Studio can integrate with SonarCube. For more information, see Gitlab integration.

How do I enable code coverage in PHPUnit?¶

Code Studio does not support PHPUnit code coverage.

How do I specify the root directory or output directory for my Node.js project?¶

• To specify the root directory, add the directory path to the extra.acquia.root_directory section in the package.json file of the root directory.
• To specify the output directory, add the directory path to the extra.acquia.output_directory section in the package.json file of the root directory. For example:

"extra": {       
             "acquia": {
               "root_directory": "front-end/",
               "output_directory": "assets/"
             }
            }

The default root directory is <project_root>/, and the default output directory is <project_root>/.next/.

Can I turn off the Test stage or Deploy stage in my Node.js Auto DevOps pipeline?¶

Yes, you can turn off these stages in your Node.js Auto DevOps pipeline:

• To turn off the Test stage, add the NODE_JOBS_TEST environment variable in Code Studio and set it to false. This setting also disables all jobs in the Test stage. For more information, see Adding environment variables. To disable certain tasks in the Test stage, see Environment variables to enable or disable a CI/CD job.
• To turn off the Deploy stage, add the NODE_JOBS_DEPLOY environment variable in Code Studio and set it to false. This setting also disables all jobs in the Deploy stage. For more information, see Adding environment variables.

Which package managers does Code Studio support for Node.js Auto DevOps?¶

Node Package Manager (NPM) is the only supported package manager in Code Studio. However, you can choose to use a before_script or after_script to modify the default pipeline and install packages using yarn.

Why are certain files in my Node.js Auto DevOps pipeline being excluded from the build artifact?¶

Code Studio excludes files with the following naming patterns as they are not required for build artifacts:

• .hg
• .git
• .gitmodules
• .svn
• .cache
• .eslintrc
• .now
• .vercel
• .npmignore
• .dockerignore
• .gitignore
• .*.swp
• .DS_Store
• .wafpicke-*
• .lock-wscript
• .env.local
• .env.*.local
• .venv
• npm-debug.log
• config.gypi
• node_modules
• __pycache__
• venv
• CVS

If a mandatory file is missing from a build artifact, rename the file to ensure that the name does not contain any of the preceding naming patterns.