rfay

DDEV Go-based Add-ons Implementation Proposal

Overview

This proposal outlines an approach to enable Go-based actions as an alternative technique for DDEV add-ons, while maintaining full support for existing bash-based actions. Both techniques will be equally supported, and add-on developers can choose the approach that best fits their needs. The solution uses Docker containers with Go runtime to build and execute Go source files on-demand, requiring only Docker (which DDEV already requires) on user machines.

Current DDEV Add-on System

DDEV add-ons currently use install.yaml with bash scripts:

rfay

======== Output file will be in /var/folders/_d/d66tr_cj5j1dq9gjr1rftddr0000gn/T/ddev-debug-test.txt ========


======== Existing project config ========
ddev installation alternate locations:
/usr/local/bin/ddev
/opt/homebrew/bin/ddev
/usr/local/bin/ddev

rfay

{
    "name": "DDEV Devcontainer setup",
    "image": "mcr.microsoft.com/devcontainers/base:latest",
    "workspaceFolder": "/var/www/html",
    "settings": {
      "terminal.integrated.cwd": "/var/www/html"
    }
  }

rfay

/Users/rfay/bin/check-addons.sh
ddev/ddev-drupal-contrib: success (2024-04-26T08:38:14Z)
torenware/ddev-viteserve: failure (2024-02-05T07:23:16Z)
Scheduled test failed in torenware/ddev-viteserve at https://github.com/torenware/ddev-viteserve/actions/runs/7780870604 (2024-02-05T07:23:16Z)
ddev/ddev-browsersync: success (2024-04-26T07:11:50Z)
ddev/ddev-selenium-standalone-chrome: success (2024-04-26T07:12:25Z)
ddev/ddev-redis: success (2024-04-26T07:11:29Z)
ddev/ddev-cron: success (2024-04-26T07:15:30Z)
justafish/ddev-drupal-core-dev: failure (2024-04-26T08:28:48Z)
Scheduled test failed in justafish/ddev-drupal-core-dev at https://github.com/justafish/ddev-drupal-core-dev/actions/runs/8845384239 (2024-04-26T08:28:48Z)

rfay

#!/bin/bash

# Go back to homebrew stable version of DDEV

set -x
set -o errexit

rm -f /usr/local/bin/ddev /opt/homebrew/bin/ddev || sudo rm -f /usr/local/bin/ddev /opt/homebrew/bin/ddev
if [ -d /opt/homebrew/bin ]; then
  ln -sf /opt/homebrew/bin/ddev /usr/local/bin/ddev

rfay

#!/bin/bash

set -eu -o pipefail

ddev config --project-type=drupal10 --docroot=web --create-docroot

if [ ! -f web/index.php ]; then
  set -x
  ddev composer create drupal/recommended-project
  ddev composer require drush/drush

rfay

Template file

Quick reference

Maintained by: the DDEV Docker Maintainers

Where to get help: DDEV Community Slack or Stack Overflow

rfay

#This uses the pimcore skeleton repo:

mkdir my-pimcore && cd my-pimcore
ddev composer create pimcore/skeleton
ddev config --docroot=public --create-docroot
ddev exec pimcore-install --mysql-username=db --mysql-password=db --mysql-host-socket=db --mysql-database=db --admin-password=admin --admin-username=admin --no-interaction
ddev launch

rfay

#!/bin/bash

set -eu -o pipefail
#set -x
if ! command -v ddev; then brew install ddev/ddev/ddev; hash -r; fi
export PROJDIR=~/tmp/junk
ddev poweroff
docker ps -a
mkdir -p ${PROJDIR}  && cd ${PROJDIR} && ddev config --auto
i=0

rfay

ENV STATIC_PHP_VERSION=7.4.30
RUN apt update && apt install -y build-essential
RUN mkdir -p /usr/local/src/static-php-cli && chown -R ${uid}:${gid} /usr/local/src
USER ${uid}:${gid}
RUN git clone https://github.com/crazywhalecc/static-php-cli.git /usr/local/src/static-php-cli/.
WORKDIR /usr/local/src/static-php-cli
RUN composer update
RUN chmod +x bin/spc
RUN ./bin/spc doctor --auto-fix