Diviner Tech Docs HarbormasterBuildStepImplementation

abstract class HarbormasterBuildStepImplementation
Phorge Technical Documentation (Harbormaster)

This class is not documented.

Tasks

Automatic Targets

No methods for this task.

Other Methods

public function setCurrentWorkerTaskID($id)
public function getCurrentWorkerTaskID()
public static function getImplementations()
public static function getImplementation($class)
public static function requireImplementation($class)
abstract public function getName() — The name of the implementation.
public function getBuildStepGroupKey()
public function getGenericDescription() — The generic description of the implementation.
public function getDescription() — The description of the implementation, based on the current settings.
public function getEditInstructions()
abstract public function execute($build, $build_target) — Run the build target against the specified build.
public function getSettings() — Gets the settings for this build step.
public function getSetting($key, $default)
final public function loadSettings($build_object) — Loads the settings for this build step implementation from a build step or target.
public function getArtifactInputs() — Return the name of artifacts produced by this command.
public function getArtifactOutputs()
public function getDependencies($build_step)
public static function getAvailableArtifacts($build_plan, $current_build_step, $artifact_type) — Returns a list of all artifacts made available in the build plan.
protected function mergeVariables($function, $pattern, $variables) — Convert a user-provided string with variables in it, like:
public function getFieldSpecifications()
protected function formatSettingForDescription($key, $default)
protected function formatValueForDescription($value)
public function supportsWaitForMessage()
public function shouldWaitForMessage($target)
protected function shouldAbort($build, $target)
protected function resolveFutures($build, $target, $futures)
protected function logHTTPResponse($build, $build_target, $future, $label)
protected function logSilencedCall($build, $build_target, $label)
public function willStartBuild($viewer, $buildable, $build, $plan, $step)
public function getBuildStepAutotargetStepKey()
public function getBuildStepAutotargetPlanKey()
public function shouldRequireAutotargeting()

Methods

public function setCurrentWorkerTaskID($id)

This method is not documented.

Parameters

$id

Return

wild

public function getCurrentWorkerTaskID()

This method is not documented.

Return

wild

public static function getImplementations()

This method is not documented.

Return

wild

public static function getImplementation($class)

This method is not documented.

Parameters

$class

Return

wild

public static function requireImplementation($class)

This method is not documented.

Parameters

$class

Return

wild

abstract public function getName()

The name of the implementation.

Return

wild

public function getBuildStepGroupKey()

This method is not documented.

Return

wild

public function getGenericDescription()

The generic description of the implementation.

Return

wild

public function getDescription()

The description of the implementation, based on the current settings.

Return

wild

public function getEditInstructions()

This method is not documented.

Return

wild

abstract public function execute($build, $build_target)

Run the build target against the specified build.

Parameters

HarbormasterBuild	$build
HarbormasterBuildTarget	$build_target

Return

wild

public function getSettings()

Gets the settings for this build step.

Return

wild

public function getSetting($key, $default)

This method is not documented.

Parameters

	$key
	$default

Return

wild

final public function loadSettings($build_object)

Loads the settings for this build step implementation from a build step or target.

Parameters

$build_object

Return

wild

public function getArtifactInputs()

Return the name of artifacts produced by this command.

Future steps will calculate all available artifact mappings before them and filter on the type.

Return

array

The mappings of artifact names to their types.

public function getArtifactOutputs()

This method is not documented.

Return

wild

public function getDependencies($build_step)

This method is not documented.

Parameters

HarbormasterBuildStep

$build_step

Return

wild

public static function getAvailableArtifacts($build_plan, $current_build_step, $artifact_type)

Returns a list of all artifacts made available in the build plan.

Parameters

HarbormasterBuildPlan	$build_plan
	$current_build_step
	$artifact_type

Return

wild

protected function mergeVariables($function, $pattern, $variables)

Convert a user-provided string with variables in it, like:

ls ${dirname}

...into a string with variables merged into it safely:

ls 'dir with spaces'

Parameters

string	$function	Name of a `vxsprintf` function, like @{function:vcsprintf}.
string	$pattern	User-provided pattern string containing `${variables}`.
dict	$variables	List of available replacement variables.

Return

string

String with variables replaced safely into it.

public function getFieldSpecifications()

This method is not documented.

Return

wild

protected function formatSettingForDescription($key, $default)

This method is not documented.

Parameters

	$key
	$default

Return

wild

protected function formatValueForDescription($value)

This method is not documented.

Parameters

$value

Return

wild

public function supportsWaitForMessage()

This method is not documented.

Return

wild

public function shouldWaitForMessage($target)

This method is not documented.

Parameters

HarbormasterBuildTarget

$target

Return

wild

protected function shouldAbort($build, $target)

This method is not documented.

Parameters

HarbormasterBuild	$build
HarbormasterBuildTarget	$target

Return

wild

protected function resolveFutures($build, $target, $futures)

This method is not documented.

Parameters

HarbormasterBuild	$build
HarbormasterBuildTarget	$target
array	$futures

Return

wild

protected function logHTTPResponse($build, $build_target, $future, $label)

This method is not documented.

Parameters

HarbormasterBuild	$build
HarbormasterBuildTarget	$build_target
BaseHTTPFuture	$future
	$label

Return

wild

protected function logSilencedCall($build, $build_target, $label)

This method is not documented.

Parameters

HarbormasterBuild	$build
HarbormasterBuildTarget	$build_target
	$label

Return

wild

public function willStartBuild($viewer, $buildable, $build, $plan, $step)

This method is not documented.

Parameters

PhabricatorUser	$viewer
HarbormasterBuildable	$buildable
HarbormasterBuild	$build
HarbormasterBuildPlan	$plan
HarbormasterBuildStep	$step

Return

wild

public function getBuildStepAutotargetStepKey()

This method is not documented.

Return

wild

public function getBuildStepAutotargetPlanKey()

This method is not documented.

Return

wild

public function shouldRequireAutotargeting()

This method is not documented.

Return

wild

Defined: src/applications/harbormaster/step/HarbormasterBuildStepImplementation.php:6

abstract class HarbormasterBuildStepImplementationPhorge Technical Documentation (Harbormaster)

Tasks

Automatic Targets

Other Methods

Methods

public function setCurrentWorkerTaskID($id)

public function getCurrentWorkerTaskID()

public static function getImplementations()

public static function getImplementation($class)

public static function requireImplementation($class)

abstract public function getName()

public function getBuildStepGroupKey()

public function getGenericDescription()

public function getDescription()

public function getEditInstructions()

abstract public function execute($build, $build_target)

public function getSettings()

public function getSetting($key, $default)

final public function loadSettings($build_object)

public function getArtifactInputs()

public function getArtifactOutputs()

public function getDependencies($build_step)

public static function getAvailableArtifacts($build_plan, $current_build_step, $artifact_type)

protected function mergeVariables($function, $pattern, $variables)

public function getFieldSpecifications()

protected function formatSettingForDescription($key, $default)

protected function formatValueForDescription($value)

public function supportsWaitForMessage()

public function shouldWaitForMessage($target)

protected function shouldAbort($build, $target)

protected function resolveFutures($build, $target, $futures)

protected function logHTTPResponse($build, $build_target, $future, $label)

protected function logSilencedCall($build, $build_target, $label)

public function willStartBuild($viewer, $buildable, $build, $plan, $step)

public function getBuildStepAutotargetStepKey()

public function getBuildStepAutotargetPlanKey()

public function shouldRequireAutotargeting()

abstract class HarbormasterBuildStepImplementation
Phorge Technical Documentation (Harbormaster)