lakedrops/dorgflow

Composer Plugin for development environments

v1.11.1 2024-02-20 16:33 UTC

Requires

• php: >=8.1
• composer-plugin-api: ^2
• cypresslab/gitelephant: ^2.0|^4.0
• lakedrops/composer-json-utils: ^2.5||dev-develop

Requires (Dev)

• composer/composer: ^2
• roave/security-advisories: dev-latest

GPL-2.0-or-later

• Jürgen Haas
• Daniel Speicher
• Richard Papp

• development

README

This is a composer plugin which prepares some of your projects in a composer based Drupal installation for drupal-org contributions powered by Dorgflow.

Installation

If you're using the Drupal Development Environment, everything is already available for you. Otherwise call composer require --dev lakedrops/dorgflow and everything will be taken care off for you automatically - even if you update your Drupal project at any time in the future, the development environments for your defined projects will be kept in place and properly configured.

Configuration

Add a dorgflow section to your .lakedrops.yml with a list of all the project you want to maintain given their respective versions:

---
dorgflow:
  projects:
    drupal/colorbox_field_formatter: 8.x-1.x
    drupal/dimension: 8.x-1.x
    drupal/drd: 8.x-3.x
    drupal/drd_agent: 8.x-3.x
  drupalspoons:
    drupal/devel: 1.x-dev
  selfhosted:
    url: gitlab.lakedrops.com
    projects:
      lakedrops/docker4drupal:
        path: composer/plugins
        version: develop

Usage

There are basicly two different use cases: for projects that you keep maintaining for a longer period of time, you add them to the extra/dorgflow section in your composer.json and when ever you run composer update, this will also refresh those projects and re-clone the projects so that you can continue maintaining them in you development environment.

For projects, you have a spontaneous need, e.g. for writing a patch to an issue, there is a quick way to achieve the same without having to run composer update. Simply add the project to the extra/dorgflow section as well and then call composer lakedrops:dorgflow. This will just checkout all the projects in this section if needed and you're ready to go.