Brad Fitzpatrick > ShipIt > ShipIt::Step

Download:
ShipIt-0.55.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  3
Open  1
View/Report Bugs
Source   Latest Release: ShipIt-0.60

NAME ^

ShipIt::Step - a unit of work to be done prior to a release

OVERVIEW ^

Each step is implemented as a ShipIt::Step subclass, implementing an 'init' and 'run' method.

METHODS ^

init($conf)

Given the provided ShipIt::Conf object, retrieve configuration keys your step know about (using $conf->value($key)), and set fields in $self (an empty hashref) for use later, in the 'run' method. You can't access the configuration later in the 'run' method, as the configuration is then locked down, already having been sanity checked for unknown or missing keys.

run($state)

Run your step. Return on success, die on failure.

Use the provided ShipIt::State $state object to inquire about the state of the release thus far, as populated by previous steps.

SEE ALSO ^

ShipIt - the ShipIt system itself

ShipIt::State

ShipIt::Conf

ShipIt::Step::FindVersion

ShipIt::Step::ChangeVersion

ShipIt::Step::DistTest

ShipIt::Step::Commit

ShipIt::Step::Tag

ShipIt::Step::Release

syntax highlighting: