docksal/blt-docksal

Docksal integration for Acquia BLT

dev-master 2022-10-14 15:17 UTC

Requires

• acquia/blt: ^13.5
• acquia/blt-behat: ^1.3

Conflicts

• acquia/blt: <13

MIT

• Docksal Team

• acquia
• blt
• docksal

README

This is an Acquia BLT plugin providing Docksal integration.

This plugin is community-created and community-supported. Acquia does not provide any direct support for this software or provide any warranty as to its stability.

Installation and usage

To use this plugin, you must already have a Drupal project using Acquia BLT.

In your project, require the plugin with Composer:

composer require docksal/blt-docksal

Initialize the Docksal integration by calling recipes:docksal:project:init, which is provided by this plugin:

./vendor/bin/blt recipes:docksal:project:init

This command will initialize .docksal folder as well as BLT configs in root/blt. Make sure to commit those changes to Git.

Initialize your project as usually with Docksal fin via fin init or repeatedly reinstall your site with fin init-site.

fin init

Even though the template in this plugin adds a default fin init command, you're free to customize it to your likings or delete.

The plugin also installs Docksal blt addon, which makes fin blt command available. You can run any BLT command directly in CLI container, for example:

fin blt tests

BLT commands support

• VM commands: Since Docksal is essentially a replacement for DrupalVM support, you shouldn't use blt vm with a Docksal BLT project. Acquia BLT assumes a local DrupalVM is used to run some BLT commands, therefore running a command in BLT makes a lot of assumptions about locally installed software, specifically Behat commands. Docksal doesn't have all the same software installed in the CLI container and instead relies on external services available on the docker network for some software support, e.g., defining chrome service in docksal.yml. Because of that, some BLT commands have to be overriden by Docksal plugin to remove those assumptions about local software.

• Behat support is implemented with ChromeDriver only, but it's trivial to add other drivers as Docksal services, pull requests welcome!