Drupal Contrib Docksal Setup

A preconfigured Docksal setup for Investis Digital contribution days. 

Installation

With the necessary tools installed, it's now possible to create a new environment with the necessary tools setup.

fin project create --repo=git@git.drupal.org:project/drupal_contrib_docksal.git --name=drupal-contrib

Prerequisites

Before you install this repo, you'll need to have Docker and Docksal installed

Docker Desktop — macOS | Linux | Windows

Docksal — macOS | Linux | Windows

Usage

This setup has been built to streamline the local development environment setup for contribution days.  It includes PHPUnit for testing your contributions as well as XDebug for profiling and debugging. When you run the command above, you will be guided through setup in the command line. There are four different options to choose from which is will help for different types of contributions.

Module

This option is for module contributions.  It will download and install Drupal, the module, and along with any other dependencies using Composer.  Once downloaded, it will helpfully replace the module using git so that you've got the latest development code installed. Once all downloads have been done, it will enable the module you're working on. 

Note: this option expects that you are working with an existing issue on Drupal.org 

Theme

This option is for theme contributions.  It will download and install Drupal, the theme, and along with any other dependencies using Composer.  Once downloaded, it will helpfully replace the module using git so that you've got the latest development code installed. Once all downloads have been done, it will enable the theme you're working on. 

Note: this option expects that you are working with an existing issue on Drupal.org 

Core

This option is for Drupal core contributions. It will download and install core from the latest version on git.

Barebones

This option is for Drupal module and/or theme contributions. It will download and install core from the latest version using Composer.  This option doesn't do any further setup so you will need to do that yourself.  Docksal is preloaded with Composer and git so you can add any code you make need.  Docksal's fin help command provides a list of available options.

Issue forks

Issue forks are supported on the module and theme installs.  When you set up one of these options you can select if you wish to use issue forks and it will add the additional remote as per https://www.drupal.org/docs/develop/git/using-git-to-contribute-to-drupa....

Installation issues

A few users have reported problems with installing and the setup throwing strange Docker errors such as volumes not mounting and images not downloading as expected.  In these instances, Docker and Docksal needed upgrading. Current versions that have been tested as working are:

Docker — 4.8.2

Docksal (fin) — 1.110.1