https://github.com/docksal/blt-docksal
Acquia BLT Docksal integration
https://github.com/docksal/blt-docksal
Last synced: over 1 year ago
JSON representation
Acquia BLT Docksal integration
- Host: GitHub
- URL: https://github.com/docksal/blt-docksal
- Owner: docksal
- Created: 2019-08-12T21:20:44.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-10-14T15:17:21.000Z (over 3 years ago)
- Last Synced: 2024-05-22T15:27:10.659Z (about 2 years ago)
- Language: PHP
- Size: 10.7 KB
- Stars: 4
- Watchers: 3
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Acquia BLT integration with Docksal
====
This is an [Acquia BLT](https://github.com/acquia/blt) plugin providing [Docksal](https://docksal.io/) 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](https://github.com/docksal/service-cli) and
instead relies on external services available on the docker network for some software support, e.g., defining chrome service in [docksal.yml](./config/.docksal/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!