README

Recipe for usage with Deployer. It includes tasks specific for SumoCoders.

Installing

composer require sumocoders/deployer-sumo-forkcms --dev

Include recipes in deploy.php file.

require __DIR__ . '/vendor/sumocoders/deployer-sumo-forkcms/sumo.php';

Available tasks

`sumo:assets:build`

Build your project's assets using Webpack.

`sumo:db:create`

Creates a database on our dev server. This task can will only run on the host with the stage "staging".

It will output the credentials.

`sumo:db:info`

This task will output the credentials of the existing database on the dev server. This task can will only run on the host with the stage "staging".

`sumo:db:create-local`

Creates a database on your local MySQL instance.

`sumo:db:get`

Run this task to replace your local database with the remote database. Be aware that no backup will be made.

`sumo:db:put`

Use this command to replace the remote database with your local database.

`sumo:project:init`

This is an aggregate task, it will run all the following tasks:

sumo:db:create-local
sumo:db:get
sumo:config:get
sumo:config:alter
sumo:files:get
sumo:assets:fix-node-version
sumo:assets:npm-install
sumo:assets:build

It can be used to locally set up a project that is already on the staging or production server.

`sumo:files:get`

Run this task to replace your local files with the remote files. Be aware that no backup will be made.

`sumo:files:put`

Run this task to replace the remote files with your local files. Be aware that no backup will be made.

`sumo:notifications:deploy`

Notify our webhooks on a deploy. This task is automatically added into the flow.

`sumo:redirect:enable`

Enable a redirect page, all traffic will be redirected to this page.

`sumo:symlink:document-root`

Creates the needed symlinks to link the document root to the correct folder.

`sumo:opcache:reset-file`

Clears opcache and statcache using a file strategy.

`sumo:cleanup:remove-files`

Removes all files that are not needed on the server. (docker-compose.yml, UPGRADE.md, etc.)

License

Licensed under the MIT license.

sumocoders / deployer-sumo-forkcms

Maintainers

Details