Overview

Features¶

The following are the features of Code Assembly:

• Automated installation of Composer dependencies specified in the composer.json and composer.lock files
• Ability to build artifacts that can be deployed to an environment

Requirements¶

The following are the requirements for using Code Assembly:

• Cloud Next environment

• For Drupal: Composer-managed application running a supported Drupal version installed on the Cloud Next environment

  Note

  • Adopt Composer as a dependency manager, and use a Composer scaffold such as Acquia’s Drupal recommended project.

    For more information, visit Using Composer with local sites.

  • Do not commit Composer-managed dependencies, such as the vendor directory, to your repository.
  • Update your .gitignore file to add rules to exclude Composer-managed files and directories, such as vendor, docroot/core, or docroot/contrib.

• For Node JS: NPM-managed JavaScript-based application using Next Generation Node as a static site or a serverless Node.js application

  Note

  • Adopt NPM as a dependency manager.
  • Do not commit NPM-managed dependencies, such as the node_modules directory, to your repository.
  • Update your .gitignore file to add rules to exclude NPM-managed files and directories such as node_modules.

Important considerations¶

• If you are already using a CI/CD tool to build and deploy hosting artifacts, do not use Code Assembly.

  Some of the examples of CI/CD tools are Code Studio, Pipelines, and GitHub Actions. These tools install dependencies, build hosting artifacts, and perform other development and DevOps tasks such as automated testing, security scanning, and code quality checks. Code Assembly is intended for customers who do not use a CI/CD tool for their Cloud Platform application.

• Deploy branches to non-production environments before deploying them to production environments.

  After deploying a branch to a non-production environment, you can use the Cloud Platform user interface to drag and drop the code to the production environment. This creates a tag from the most recent commit. For more information, visit Moving code from one environment to another.

• Use Cloud Actions to automate common Drupal tasks in environments during deployments.

Terminology¶

The following are the frequently used terms related to Code Assembly:

• Artifact: A hosting artifact includes all installed and sanitized dependencies that are necessary to host and use a Drupal application.
• Environment: A Cloud Next environment where you deploy code. For example, dev, stage, or prod.
• Scaffolding: A composer scaffold is a project template that includes:
  • The composer.json and .lock files
  • The appropriate .gitignore rules for the repository
  • Locations defined in the composer.json file for managed dependencies 

Limitations¶

The following are the limitations of Code Assembly:

• Code Assembly can be enabled only for Cloud Next applications.
• Code Assembly supports only public repositories.
• Code Assembly can currently build artifacts only for public repositories and not for private repositories.
• For PHP applications, Code Assembly uses 128 MB PHP memory to build code. This value cannot be changed in the current version.
• Code Assembly does not support custom configurations through the user interface.
  • Code Assembly fails if the composer.json file is missing from PHP applications and the package.json file is missing from Node.js applications.
  • For Node.js applications, Code Assembly reads configurations from the package.json file present in the source directory of your Git repository. It reads the values of node_version, install_command and root_directory.
  • For Drupal applications, Code Assembly reads configurations from the composer.json file present in the source directory of your Git repository. It reads the value of php_version.
• For SSG applications, the artifact size of the static site is limited to 10 GB. If the artifact size exceeds 10 GB, Code Assembly causes the build process to fail.
• For Drupal applications, Code Assembly supports Composer as the package manager.
• For Node.js applications, Code Assembly supports npm as the package manager.
• Code Assembly causes the build process to fail if artifacts are already present in the source directory of your Git repository.