Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
ShipIt::Step(3)	      User Contributed Perl Documentation      ShipIt::Step(3)

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

perl v5.24.1			  2012-07-21		       ShipIt::Step(3)

NAME | OVERVIEW | METHODS | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=ShipIt::Step&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help