Skip to main content

Steps reference

Abstract

A Step encapsulates a build task: the code to perform that task, the inputs and parameters you can define for the task, and the outputs the task generates.

A Step encapsulates a build task: the code to perform that task, the inputs and parameters you can define for the task, and the outputs the task generates.

For example the Git Clone Step performs a git clone of the specified repository, with the specified inputs, such as the branch or the commit to clone.

From a technical perspective, a Step is a semver versioned repository which includes the code of the Step and the interface definition of the Step.

The Step interface definition is defined in the step.yml file for every Step. It includes:

  • The dependencies of the Step.

  • The inputs and outputs of the Step.

  • The title and description of the Step.

  • Properties such as the issue tracker or support URL, or certain filter properties.

To include Steps in your Workflow, you have to reference them in the bitrise.yml file of your app. To do so, you will need the correct reference format for the Step. In the configuration file, you can also specify input values for the inputs defined in the Step's interface definition.

In this section:

The interface definition of a Bitrise Step. It defines the Step inputs and the generated outputs, as well as any other Step property such as the category and the description of the Step. It also points to the Step's source code.

A Workflow is a collection of Steps, Environment Variables, and other configurations. When Bitrise starts a build, it runs one or more Workflows according to the configuration defined in the bitrise.yml file.

The bitrise.yml file stores your entire build configuration for an app. It specifies your stack and the build triggers, and defines the Workflows of the app. When you make changes on the graphical UI of our Workflow Editor, you actually modify the bitrise.yml file.