Class: Highway::Steps::Step

Inherits:

Object

• Object
• Highway::Steps::Step

Defined in:

lib/highway/steps/step.rb

Overview

This class serves as a base class for all step definition classes. It contains a common API and some useful utilities.

Direct Known Subclasses

Library::ActionStep, Library::AppCenterStep, Library::AppStoreStep, Library::CarthageStep, Library::CocoaPodsStep, Library::CodeSignStep, Library::CopyArtifactsStep, Library::LaneStep, Library::ShStep, Library::SlackStep, Library::TestFlightStep, Library::XcodeArchiveStep, Library::XcodeTestStep

Class Method Summary

• .name ⇒ String

  Name of the step as it appears in configuration file.

• .parameters ⇒ Array<Highway::Steps::Parameters::*>

  Parameters that this step recognizes.

• .root_parameter ⇒ Highway::Steps::Parameters::Compound

  The root parameter that nests all parameters of the step.

• .run(parameters:, context:, report:) ⇒ Void

  Run the step in given context containing inputs and Fastlane runner.

Class Method Details

.name ⇒ String

Name of the step as it appears in configuration file.

Returns:

• (String)

Raises:

• (NotImplementedError)

# File 'lib/highway/steps/step.rb', line 20

def self.name
  raise NotImplementedError.new("You must override `#{__method__.to_s}` in `#{self.class.to_s}`.")
end

.parameters ⇒ Array<Highway::Steps::Parameters::*>

Parameters that this step recognizes.

Returns:

• (Array<Highway::Steps::Parameters::*>)

Raises:

• (NotImplementedError)

# File 'lib/highway/steps/step.rb', line 27

def self.parameters
  raise NotImplementedError.new("You must override `#{__method__.to_s}` in `#{self.class.to_s}`.")
end

.root_parameter ⇒ Highway::Steps::Parameters::Compound

The root parameter that nests all parameters of the step.

Returns:

• (Highway::Steps::Parameters::Compound)

# File 'lib/highway/steps/step.rb', line 34

def self.root_parameter
  return Parameters::Compound.new(name: "root", required: true, defaults: true, children: parameters)
end

.run(parameters:, context:, report:) ⇒ Void

Run the step in given context containing inputs and Fastlane runner.

Parameters:

• parameters (Hash) —

  Parameters of the step.

• context (Highway::Runtime::Context) —

  The runtime context.

• report (Highway::Runtime::Report) —

  The current runtime report.

Returns:

• (Void)

Raises:

• (NotImplementedError)

# File 'lib/highway/steps/step.rb', line 45

def self.run(parameters:, context:, report:)
  raise NotImplementedError.new("You must override `#{__method__.to_s}` in `#{self.class.to_s}`.")
end