Skip to main content

Configuration YAML

Abstract

Your Bitrise CI configuration is defined and stored inside YAML files that define the version of the Bitrise CLI the build will use, the stack and machine type, the trigger map, and even Environment Variables.

Your Bitrise CI configuration is defined and stored inside YAML files. When you modify your configuration on the GUI of the Workflow Editor, you modify YAML files. The files define:

  • The format version of the Bitrise CLI the build will use. The format version number determines what Bitrise CLI versions will be able to run the configuration.

  • The type of the project (for example, Android or iOS).

  • The default source of Steps used.

  • The stack and machine type of the build and of the specific Workflows.

  • The trigger map: your configuration of automatic build triggers based on Git events.

  • App- and Workflow-level Environment Variables accessible to the build.

  • The Workflows and Steps used in the build.

The default configuration YAML file is called bitrise.yml. Each Bitrise project has a bitrise.yml file. You can find detailed reference information on the bitrise.yml file: Basics of configuration YAML.

This file can be stored on:

  • bitrise.io. This is the default setting.

  • Your own Git repository.

If you store your YAML configuration in your own Git repository, you can also use a modular YAML configuration. This means that in addition to the default bitrise.yml configuration file, you have one or more additional YAML files containing additional configuration. This allows breaking down large configurations into smaller, modular components, as well as efficient reuse of configuration segments across multiple different repositories and Bitrise projects.

Enterprise only

A modular YAML configuration is only available to Workspaces on an Enterprise plan. For now, it is not available if you store your YAML configuration on bitrise.io.