Tasks - waffle-ops/waffle GitHub Wiki

Waffle comes packaged with some tasks that can help automate workflows for your project. Below you will find a list of all the tasks that Waffle provides out of the box.

Note: For more information about any of the following tasks, try running wfl help [task] (unless it is overridden or defined -- in that case you are on your own).

build-backend

Attempts to build the backend of your project. Currently, a composer strategy is supported for composer enabled projects. There is also a null build strategy for cases where no build is required.

Usage: wfl build-backend --strategy=[strategy]

Tip: You can tell Waffle to always default to a specific strategy by defining the following in your `.waffle.yml file:

build-backend:
  strategy: [composer|null]

If this config is provided, you can simply run wfl build-backend.

---

build-frontend

Attempts to build the frontend of your project. Currently, a gulp strategy is supported for composer enabled projects. There is also a null build strategy for cases where no build is required.

Note: The gulp strategy assumes that there is a build task defined in your gulpfile.

Usage: wfl build-backend --strategy=[strategy]

Tip: You can tell Waffle to always default to a specific strategy by defining the following in your `.waffle.yml file:

build-frontend:
  strategy: gulp
  dir: your/theme/directory

If this config is provided, you can simply run wfl build-frontend.

---

sync-db

Provides an easy way to download and install the database from an upstream source.

Note: Currently the sync-db comand only works for Drupal sites using Drush. You must have your alias configured in .waffle.yml and have the proper access to pull down the database.

Note: The sync-db command will use the default_upstream value from your .waffle.yml file if you do not pass in a specific upstream environment with the --upstream=[env] option.

Usage: wfl sync-db

---

sync-files

Provides an easy way to download and the site files from an upstream source.

Note: Currently the sync-files comand only works for Drupal sites using Drush. You must have your alias configured in .waffle.yml and have the proper access to pull down the database.

Note: The sync-db command will use the default_upstream value from your .waffle.yml file if you do not pass in a specific upstream environment with the --upstream=[env] option.

Usage: wfl sync-files

---

login

Attempts to log the user into the site.

Note: Currently the login comand only works for Drupal sites using Drush. You must have your alias configured in .waffle.yml and have the proper access to pull down the database. You must also have your site uri configured properly in a drush.yml file.

Usage: wfl login

---

release-script

Attempts to log the user into the site.

Note: The release-script assumes your release script exists at ../private/releases/release.sh. If you are storing your release script elsewhere, you will need to pass in the correct script by passing the --script=path/to/your/script/sh option.

Usage: wfl release-script

---

update-apply

Attempts to apply pending updates to a project.

Usage: wfl update-apply

---

update-prepare

Attempts to prepare a project for applying updates.

Note: The update-prepare command will create a new feature branch using git. The updates will be applied to this feature brach.

Usage: wfl update-prepare

---

update-status

Attempts to get a report of pending updates for the project.

The update-status command will attempt to check for pending updates via all relavent sources including, symfony, drush, composer, and wp-cli.

Usage: wfl update-status

---

If you have some ideas for tasks feel free to suggest something in the issue queue!