https://github.com/sourcebroker/deployer-loader

Autoload of root project vendors and recursive load of deployer tasks.
https://github.com/sourcebroker/deployer-loader

deployer deployment loader php sb-dl

Last synced: 4 days ago
JSON representation

Autoload of root project vendors and recursive load of deployer tasks.

• Host: GitHub
• URL: https://github.com/sourcebroker/deployer-loader
• Owner: sourcebroker
• License: mit
• Created: 2017-10-01T11:17:23.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-12-28T15:32:55.000Z (over 2 years ago)
• Last Synced: 2024-11-08T00:09:41.057Z (6 months ago)
• Topics: deployer, deployment, loader, php, sb-dl
• Language: PHP
• Homepage:
• Size: 21.5 KB
• Stars: 4
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
deployer-loader

===============

|

.. image:: http://img.shields.io/packagist/v/sourcebroker/deployer-loader.svg?style=flat

   :target: https://packagist.org/packages/sourcebroker/deployer-loader

.. image:: https://img.shields.io/badge/license-MIT-blue.svg?style=flat

   :target: https://packagist.org/packages/sourcebroker/deployer-loader

|

.. contents:: :local:

What does it do?

----------------

This package allows to load:

1) single task or set of tasks from given path -> loader type: ``path``

2) set of tasks from "deployer" folder of composer package -> loader type: ``package``

3) loader config from composer package -> loader type: ``get``

Installation

------------

::

  composer require sourcebroker/deployer-loader

Usage

-----

- TYPE ``path``

  You can load single file or multiple files. You can use ``excludePattern`` to exclude.

  ::

   new \SourceBroker\DeployerLoader\Load(

      ['path' => 'vendor/sourcebroker/deployer-extended-database/deployer/db/task/db:copy.php'],

      ['path' => 'vendor/sourcebroker/deployer-extended-database/deployer/db/task/db:move.php'],

   );

   new \SourceBroker\DeployerLoader\Load(

      ['path' => 'vendor/sourcebroker/deployer-extended-database/deployer/db', 'excludePattern' => '/move/'],

      ['path' => 'vendor/sourcebroker/deployer-extended-media/deployer/media'],

   );

- TYPE ``file_phar``

  A file is loaded from relative to root project. Allows to include Deployer phar file.

  ::

   new \SourceBroker\DeployerLoader\Load(

      ['file_phar' => 'recipe/common.php'],

   );

- TYPE ``package``

  Files are loaded recursively form given package from hardcoded folder ``deployer``.

  ::

   new \SourceBroker\DeployerLoader\Load(

      ['package' => 'sourcebroker/deployer-extended-database'],

      ['package' => 'sourcebroker/deployer-extended-media'],

   );

- TYPE ``get``

  In case of ``get`` first the file with array of loader configurations is read from given package.

  The logic to read the file is like:

  - First it checks if the composer.json file contains the key ``extra.sourcebroker/deployer.loader-file``.

  - If the key exists, it read it and execute inclusions.

  - If the key does not exist, it defaults to the path ``config/loader.php`` within the package directory.

  Then the loader configurations read from that file are executed.

  Example of loader file: https://github.com/sourcebroker/deployer-typo3-database/blob/main/config/loader.php

  ::

   new \SourceBroker\DeployerLoader\Load(

      ['get' => 'sourcebroker/deployer-typo3-database'],

      ['get' => 'sourcebroker/deployer-typo3-media'],

      ['get' => 'sourcebroker/deployer-typo3-deploy-ci'],

   );

Changelog

---------

See https://github.com/sourcebroker/deployer-loader/blob/master/CHANGELOG.rst