README

Important

Read-only mirror. This repository is a subtree split of kanopi/kanopi-assets and is updated automatically. Issues are disabled and pull requests are closed automatically — report issues and open pull requests on the main kanopi-assets repository.

CircleCI deployment configuration for Drupal on Pantheon, built on the Kanopi orbs (kanopi/ci-tools, kanopi/cms-updates). Pantheon uses Multidev for preview/QA, so there is no Tugboat config here.

Scaffolds

The logic lives in the orbs and the shipped files; per-project values live only in env.sh. Bump the orb version or update this package to roll a fix to every site. To diverge, a site sets ".circleci/config.yml": false (or the script path) in its own composer.json and commits its own copy.

Fill in .circleci/env.sh

TERMINUS_SITE, PANTHEON_UUID, DEFAULT_BRANCH, DOCROOT, THEME_NAME, THEME_PATH, NODE_VERSION, NODE_PACKAGE_MANAGER (npm/yarn). The PHP version is a pipeline parameter at the top of config.yml (the docker image resolves before env.sh can be sourced); Node is installed at runtime via nvm, so NODE_VERSION lives in env.sh.

Deploy hooks

pre-deploy.sh and post-deploy.sh (seeded once, committed, yours to edit) let you customize the deploy without forking dev-multidev. They ship empty and run only if present — pre-deploy.sh before the artifact is pushed, post-deploy.sh after the release tasks (drush deploy + cache clear), with $TERMINUS_SITE.$TERMINUS_ENV in scope and terminus authenticated.

These are CI-side hooks (CircleCI deploys to dev/multidev). For platform deploys (dev→test→live promotions), see Quicksilver below.

Quicksilver hooks

pantheon.yml registers workflows.deploy.after hooks that run on Pantheon after every code deploy — including dashboard promotions that never touch CI:

• drush-deploy.php — runs drush deploy (db updates, cache rebuild, config import, deploy hooks) on the deployed environment.
• new_relic_deploy.php — records a deploy marker in New Relic. Requires the site secret: terminus secret:site:set <site> new_relic_api_key <key>.

install-quicksilver.sh stages these into web/private/scripts/quicksilver/ (or private/… when web_docroot is false) during the deploy, reading web_docroot from pantheon.yml. If your project already has a pantheon.yml, the seeded one is skipped — copy its workflows block in by hand, and keep the script paths aligned with your web_docroot.

Toggling stages

• Theme build — set BUILD_THEME="false" in env.sh for a theme-less / no-build site (compile-theme.sh then skips the build; it also auto-skips when the theme has no package.json).
• Post-deploy jobs — config.yml exposes boolean pipeline parameters (run_cypress, run_lighthouse, run_pa11y, run_sdtt, run_backstop), all default true. Flip a default to false to skip that job. These are jobs, not steps, so they live in config.yml, not env.sh — CircleCI resolves the workflow before env.sh is sourced.

Secrets (CircleCI kanopi-code context — never in the repo)

TERMINUS_TOKEN, GITHUB_TOKEN, DOCKERHUB_USER, DOCKERHUB_PASS, SLACK_WEBHOOK. Add the deploy SSH key under Project Settings → SSH Keys.

Scheduled pipelines

• automatic updates — name a CircleCI scheduled trigger automatic updates.
• cron job … — name a trigger starting with cron job; set the cron_env pipeline parameter to the target Pantheon env.