README

This repository is a start state for a Composer-based Drupal (Lightning Distro) workflow with Pantheon. It is meant to be copied by the the Terminus Build Tools Plugin which will set up for you a brand new site.

GitHub repo
Free Pantheon sandbox site
A CircleCI configuration to run tests and push from the source repo (GitHub) to Pantheon.

For more background information on this style of workflow, see the Pantheon documentation.

Installation

Prerequisites

Before running the terminus build:project:create command, make sure you have all of the prerequisites:

A Pantheon account
Terminus, the Pantheon command line tool
The Terminus Build Tools Plugin
An account with GitHub and an authentication token capable of creating new repos.
An account with CircleCI and an authentication token.

You may find it easier to export the GitHub and CircleCI tokens as variables on your command line where the Build Tools Plugin can detect them automatically:

export GITHUB_TOKEN=[REDACTED]
export CIRCLE_TOKEN=[REDACTED]

One command setup:

Once you have all of the prerequisites in place, you can create your copy of this repo with one command:

terminus build:project:create ui-research/lightning-drops-8-composer:dev-master my-new-site --org="UI-Research"

if this is part of the Urban "Team" there is an extra flag like so:

terminus build:project:create ui-research/lightning-drops-8-composer:dev-master my-new-site --org="UI-Research" --team="The Urban Institute"

The parameters shown here are:

The name of the source repo, UI-Research/lightning-drops-8-composer. If you are interest in other source repos like WordPress, see the Terminus Build Tools Plugin.
The machine name to be used by both the soon-to-be-created Pantheon site and GitHub repo. Change my-new-site to something meaningful for you.
The --org flag is optional and refers to a Github organization.
The --team flag is optional and refers to a Pantheon organization.

Important files and directories

`/web`

Pantheon will serve the site from the /web subdirectory due to the configuration in pantheon.yml, facilitating a Composer based workflow. Having your website in this subdirectory also allows for tests, scripts, and other files related to your project to be stored in your repo without polluting your web document root.

`/config`

One of the directories moved to the git root is /config. This directory holds Drupal's .yml configuration files. In more traditional repo structure these files would live at /sites/default/config/. Thanks to this line in settings.php, the config is moved entirely outside of the web root.

`composer.json`

If you are just browsing this repository on GitHub, you may notice that the files of Drupal core itself are not included in this repo. That is because Drupal core and contrib modules are installed via Composer and ignored in the .gitignore file. Specific contrib modules are added to the project via composer.json and composer.lock keeps track of the exact version of each modules (or other dependency). Modules, and themes are placed in the correct directories thanks to the "installer-paths" section of composer.json. composer.json also includes instructions for drupal-scaffold which takes care of placing some individual files in the correct places like settings.pantheon.php.

Behat tests

So that CircleCI will have some test to run, this repository includes a configuration of Behat tests. You can add your own .feature files within /tests/features/.

Updating your site

When using this repository to manage your Drupal site, you will no longer use the Pantheon dashboard to update your Drupal version. Instead, you will manage your updates using Composer. Ensure your site is in Git mode, clone it locally, and then run composer commands from there. Commit and push your files back up to Pantheon as usual.

ui-research / lightning-drops-8-composer

Maintainers

Details