Contributing Actions and Movers

theory edited this page Aug 16, 2010 · 1 revision
Clone this wiki locally

A relatively simple way to contribute to Bricolage is to provide actions and movers. These are plugin modules that can add new functionality to Bricolage without needing to make changes to the existing API.

An “action” is an act that is performed on files before they are distributed. Say you want to clean the HTML of all of your HTML files before they’re distributed. You’ll need to create an action to do this. Consult Bric::Dist::Action for information on how to create actions.

Say you need to distribute files via a protocol that Bricolage doesn’t currently support — say, an new variant of FTP called “FooTP.” You’ll need to create a new mover. Consult Bric::Dist::Action::Mover for details on how to do that.