thinkshout/drupal-project

ThinkShout's project template for Drupal 8 projects with composer


License
CNRI-Python-GPL-Compatible

Documentation

Drupal Project (Pantheon edition)

Note: This project was forked from the drupal-project repository.

Development set-up

This is a Drupal 8 site built using the robo taskrunner. As such, it does not require separate /project and ~/Sites folders. Install the repo directly into ~/Sites using git clone and you will be ready to begin.

First you need to install composer.

brew install composer

Next add ./vendor/bin to your PATH, at the beginning of your PATH variable, if it is not already there.

Check with: echo $PATH

Update with: export PATH=./vendor/bin:$PATH

Add the custom git repo to your list of available composer paths by opening (or creating) ~/.composer/config.json and adding these lines:

{
    "config": {
    },
    "repositories": [
        {
            "type": "vcs",
            "url": "https://github.com/thinkshout/drupal-project"
        }
    ]
}

Building

Start inside the ~/Sites directory and build your site (replace 'some-dir' with the name of the project folder):

composer create-project thinkshout/drupal-project:8.x-pantheon-dev some-dir --stability dev --no-interaction

Start inside the ~/Sites/SITE directory you cloned (you may have named it something other than "SITE")

Get the all the dependencies and modules with:

composer install

Running the robo configure command will read the .env.dist, cli arguments and your local environment (DEFAULT_PRESSFLOW_SETTINGS) to generate a .env file. This file will be used to set the database and other standard configuration options. If no database name is provided, the project name and the git branch name will be used.

robo configure
# Use an alternate DB password
robo configure --db-pass=<YOUR LOCAL DATABASE PASSWORD>

The structure of DEFAULT_PRESSFLOW_SETTINGS if you want to set it locally is:

DEFAULT_PRESSFLOW_SETTINGS_={"databases":{"default":{"default":{"driver":"mysql","prefix":"","database":"","username":"root","password":"root","host":"localhost","port":3306}}},"conf":{"pressflow_smart_start":true,"pantheon_binding":null,"pantheon_site_uuid":null,"pantheon_environment":"local","pantheon_tier":"local","pantheon_index_host":"localhost","pantheon_index_port":8983,"redis_client_host":"localhost","redis_client_port":6379,"redis_client_password":"","file_public_path":"sites\/default\/files","file_private_path":"sites\/default\/files\/private","file_directory_path":"site\/default\/files","file_temporary_path":"\/tmp","file_directory_temp":"\/tmp","css_gzip_compression":false,"js_gzip_compression":false,"page_compression":false},"hash_salt":"","config_directory_name":"sites\/default\/config","drupal_hash_salt":""}

Installing

Running the robo install command will run composer install to add all required dependencies and then install the site and import the exported configuration.

robo install

Testing

Test are run automatically on CircleCI, but can be run locally as well with:

robo test

Updating contributed code

Updating contrib modules

With composer require drupal/{module_name} you can download new dependencies to your installation.

composer require drupal/devel:8.*

Applying patches to contrib modules

If you need to apply patches (depending on the project being modified, a pull request is often a better solution), you can do so with the composer-patches plugin.

To add a patch to drupal module "foobar" insert the patches section in the extra section of composer.json:

"extra": {
    "patches": {
        "drupal/foobar": {
            "Patch description": "URL to patch"
        }
    }
}

Updating Drupal Core

This project will attempt to keep all of your Drupal Core files up-to-date; the project drupal-composer/drupal-scaffold is used to ensure that your scaffold files are updated every time drupal/core is updated. If you customize any of the "scaffolding" files (commonly .htaccess), you may need to merge conflicts if any of your modfied files are updated in a new release of Drupal core.

Follow the steps below to update your core files.

  1. Run composer update drupal/core.
  2. Run git diff to determine if any of the scaffolding files have changed. Review the files for any changes and restore any customizations to .htaccess or robots.txt.
  3. Commit everything all together in a single commit, so web will remain in sync with the core when checking out branches or running git bisect.
  4. In the event that there are non-trivial conflicts in step 2, you may wish to perform these steps on a branch, and use git merge to combine the updated core files with your customized files. This facilitates the use of a three-way merge tool such as kdiff3. This setup is not necessary if your changes are simple; keeping all of your modifications at the beginning or end of the file is a good strategy to keep merges easy.