flywheel-deploy-client v0.0.1

flywheel-deploy-client

A small client library for deploying a WordPress site to FlyWheel.

Usage

Be sure the following environment variables are set when using the client.

• DEPLOY_SFTP_USERNAME: FlyWheel SFTP username
• DEPLOY_SFTP_PASSWORD: FlyWheel SFTP password
• DEPLOY_WP_ROOT_PATH: FlyWheel SFTP remote directory (e.g. /org-your-org/your-site_staging)

Then in your build script...

const DeployClient = require('flywheel-deploy-client'),
  client = new DeployClient('/path/to/loca/wordpress');
 
 client.deploy();

Process

Currently, this client doesn't look at git or any other version control for your project. It simply recursively deletes the following remote directories:

• wp-content/plugins
• wp-content/mu-plugins

• wp-content/themes

  And then uploads the corresponding directories from your local project in their places.

  Note: This client uses console.log( . . . ) to output it's progress.

TODO

• Use a config object passed to the constructor instead of env variables.
• Report progress, failures, and completion using Promises or EventEmitter

License

ISC