Customizing a default Code Studio pipeline¶

Environment variables¶

The Code Studio pipeline is ready-for-use and out-of-the-box. However, it is also customizable to fit the needs of different projects.

You can use environment variables to:

• Override default values of the CI/CD pipeline

• Enable or disable specific jobs

• 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.

Customizing the Code Studio pipeline¶

For any default job run by Code Studio AutoDevOps, you can:

• Enable or disable the job using an environment variable.
• Add a before_script to execute your own custom script before the Code Studio script.
• Replace the default script with your own custom script.
• Add an after_script to execute your own custom script after the Code Studio script.

Enabling or disabling a default Code Studio job¶

To enable or disable the job, you can set any of the following values to “true” or “false” by going to Settings > CI/CD > Variables or adding in .gitlab-ci.yml:

For example:

include:
  - project: 'acquia/standard-template'
    file:
      - '/gitlab-ci/Auto-DevOps.acquia.gitlab-ci.yml'
variables:
  - ACQUIA_JOBS_CREATE_CDE: “false”

Adding a before_script or after_script to a Code Studio job¶

include:
  - project: 'acquia/standard-template'
    file:
      - '/gitlab-ci/Auto-DevOps.acquia.gitlab-ci.yml'
"Test Drupal":
  before_script:
    - echo “Hello world!”

Building front-end dependencies¶

A common use case for customizing a job is to build front-end dependencies. There are many ways you can do this. For example, you can create a custom Composer script named build-theme and call it during a CI/CD build.

An advantage of wrapping your commands in a Composer script is that you can easily run the command during a build, and also within your IDE.

For example, in composer.json

  "scripts": {
       "build-theme": ["[ -s \"$NVM_DIR/nvm.sh\" ] && . \"$NVM_DIR/nvm.sh\" && cd
docroot/themes/custom/mytheme && nvm install && nvm use && npm install && npm run build"]
   }

For example, in .gitlab-ci.yml:

"Deploy Branch to Acquia":
  before_script:
    - composer run-script build-theme

"Deploy Tag to Acquia":
  before_script:
    - composer run-script build-theme

You can then run composer run-script build-theme in an IDE whenever you need to build theme dependencies.

Using BLT with Code Studio¶

Code Studio is built to easily integrate with BLT (Build and Launch Tool). Using both tools, you can quickly have an advanced, comprehensive Drupal CI/CD workflow running in a couple of minutes.

1. Run the following command to add BLT:

   composer require acquia/blt
   

2. In blt/blt.yml, place your Cloud Platform application Git URL in the git.remotes array, and then disable the Git hooks:

   git:
       remotes:
           - [email protected]:foo.git
       hooks:
           pre-commit: false
           pre-push: false
           commit-msg: false
   

3. Commit and push your changes.

   Code Studio now uses BLT in AutoDev Ops.