{"id":20134398,"url":"https://github.com/wearerequired/composer-deployer","last_synced_at":"2025-04-09T17:15:54.397Z","repository":{"id":40547189,"uuid":"297711167","full_name":"wearerequired/composer-deployer","owner":"wearerequired","description":"🚀 Composer plugin to create a deployer config (deploy.php) with custom deployment tasks.","archived":false,"fork":false,"pushed_at":"2024-12-02T18:30:10.000Z","size":85,"stargazers_count":5,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-09T17:15:47.344Z","etag":null,"topics":["composer-plugin","deployer"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wearerequired.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-09-22T16:41:20.000Z","updated_at":"2024-12-02T18:29:20.000Z","dependencies_parsed_at":"2024-02-03T17:23:40.677Z","dependency_job_id":"29c0cd3c-6157-4866-86c1-1f4fef7f619b","html_url":"https://github.com/wearerequired/composer-deployer","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wearerequired%2Fcomposer-deployer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wearerequired%2Fcomposer-deployer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wearerequired%2Fcomposer-deployer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wearerequired%2Fcomposer-deployer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wearerequired","download_url":"https://codeload.github.com/wearerequired/composer-deployer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248074922,"owners_count":21043490,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["composer-plugin","deployer"],"created_at":"2024-11-13T21:09:26.371Z","updated_at":"2025-04-09T17:15:54.378Z","avatar_url":"https://github.com/wearerequired.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# composer-deployer\n\n[![Latest Stable Version](https://poser.pugx.org/wearerequired/composer-deployer/v/stable)](https://packagist.org/packages/wearerequired/composer-deployer)\n[![Latest Unstable Version](https://poser.pugx.org/wearerequired/composer-deployer/v/unstable)](https://packagist.org/packages/wearerequired/composer-deployer)\n\n\nA plugin for Composer to create the Deployer configuration file (deploy.php).\n\n## Installation\n\nVia Composer\n\n```\ncomposer require wearerequired/composer-deployer\n```\n\n## Features\n\n* Supports for Deployer v7.\n* Creates `deploy.php` in project root directory.\n* Defines a `deploy` task to deploy a project.\n* Installs and updates WordPress translations via WP-CLI if `wp_languages` option is set.\n* 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.\n* Runs WordPress database routine if `wordpress` option is set.\n* Runs custom commands via `post_rollout_commands` option before the deployment is finished.\n* Provides a [reusable workflow for GitHub](./.github/workflows/deploy.yml) for deployment.\n\n## Configuration\n\nNext 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:\n\n```yml\n.base: \u0026base\n  hostname: ssh.example.ch\n  remote_user: jane\n  application: example.ch\n  repository: git@github.com:wearerequired/example.git\n  deploy_path: ~/public_html/{{application}}/{{stage}}\n  branch: main\n  shared_files:\n    - wordpress/.htaccess\n  shared_dirs:\n    - wordpress/content/uploads\n  wp_languages:\n    - de_DE\n    - de_DE_formal\n    - de_CH\n  wp_clear_opcache: true\n  post_rollout_commands:\n    - \"{{bin/wp}} litespeed-purge all || true\"\n\nhosts:\n  staging:\n    \u003c\u003c: *base\n    labels:\n      stage: staging\n\n  production:\n    \u003c\u003c: *base\n    branch: production\n    shared_files:\n      - wordpress/.htaccess\n      - wordpress/google123456789abc.html\n    labels:\n      stage: production\n```\n\n\u003cbr\u003e\n\n[![a required open source product - let's get in touch](https://media.required.com/images/open-source-banner.png)](https://required.com/en/lets-get-in-touch/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwearerequired%2Fcomposer-deployer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwearerequired%2Fcomposer-deployer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwearerequired%2Fcomposer-deployer/lists"}