PHPackages                             wearerequired/composer-deployer - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [DevOps & Deployment](/categories/devops)
4. /
5. wearerequired/composer-deployer

ActiveComposer-plugin[DevOps & Deployment](/categories/devops)

wearerequired/composer-deployer
===============================

A composer plugin to create a deployer configuration file.

v1(3mo ago)519.5k↑55.6%3[1 issues](https://github.com/wearerequired/composer-deployer/issues)[2 PRs](https://github.com/wearerequired/composer-deployer/pulls)MITPHPPHP >=7.4CI passing

Since Sep 22Pushed 2w agoCompare

[ Source](https://github.com/wearerequired/composer-deployer)[ Packagist](https://packagist.org/packages/wearerequired/composer-deployer)[ RSS](/packages/wearerequired-composer-deployer/feed)WikiDiscussions master Synced 2d ago

READMEChangelog (10)Dependencies (6)Versions (16)Used By (0)

composer-deployer
=================

[](#composer-deployer)

[![Latest Stable Version](https://camo.githubusercontent.com/b4c04543920bec42b185727200416c521ea56f3376948baa918175178f7016a3/68747470733a2f2f706f7365722e707567782e6f72672f776561726572657175697265642f636f6d706f7365722d6465706c6f7965722f762f737461626c65)](https://packagist.org/packages/wearerequired/composer-deployer)[![Latest Unstable Version](https://camo.githubusercontent.com/9540ba33aad7190195d0d9bee2a179620c59304dc3b129cbb7d4623e60d8c339/68747470733a2f2f706f7365722e707567782e6f72672f776561726572657175697265642f636f6d706f7365722d6465706c6f7965722f762f756e737461626c65)](https://packagist.org/packages/wearerequired/composer-deployer)

A plugin for Composer to create the Deployer configuration file (deploy.php).

Installation
------------

[](#installation)

Via Composer

```
composer require wearerequired/composer-deployer

```

Features
--------

[](#features)

- Supports for Deployer v7.
- Creates `deploy.php` in project root directory.
- Defines a `deploy` task to deploy a project.
- Installs and updates WordPress translations via WP-CLI if `wp_languages` option is set.
- Clears OPcache via WP-CLI (requires [WP-CLI Clear OPcache](https://github.com/wearerequired/wp-cli-clear-opcache)). Can be disabled via `wp_clear_opcache` option.
- Runs WordPress database routine if `wordpress` option is set.
- Runs custom commands via `post_rollout_commands` option before the deployment is finished.
- Provides a [reusable workflow for GitHub](./.github/workflows/deploy.yml) for deployment.

Configuration
-------------

[](#configuration)

Next to `deploy.php` you should create a `deploy.yml` file in the project root directory. For the supported syntax see [Deployer's documentation](https://deployer.org/docs/7.x/yaml) or the following example:

```
.base: &base
  hostname: ssh.example.ch
  remote_user: jane
  application: example.ch
  repository: git@github.com:wearerequired/example.git
  deploy_path: ~/public_html/{{application}}/{{stage}}
  branch: main
  shared_files:
    - wordpress/.htaccess
  shared_dirs:
    - wordpress/content/uploads
  wp_languages:
    - de_DE
    - de_DE_formal
    - de_CH
  wp_clear_opcache: true
  post_rollout_commands:
    - "{{bin/wp}} litespeed-purge all || true"

hosts:
  staging: