Skip to main content

Editing a project's configuration YAML

Abstract

You can edit the file on bitrise.io, in the graphical Workflow Editor, or you can download it and edit it locally. Whenever you modify a Workflow or a Step in the Workflow Editor, you're indirectly editing the app's bitrise.yml configuration file.

Your Bitrise configuration is defined in YAML files. All Bitrise projects have a root bitrise.yml file which defines Pipelines, Workflows, app-level Environment Variables, the trigger map, and stack types and machine types for your project. You can edit this file in three different ways:

Whenever you modify a Workflow or a Step in the Workflow Editor, you're indirectly editing the app's bitrise.yml configuration file. However, if you prefer, you can edit the file directly, in YAML.

Important

This requires some familiarity with the structure of the bitrise.yml file. Read more: Basics of configuration YAML

You can edit the file on bitrise.io, in the graphical Workflow Editor, or you can download it and edit it locally.

Editing the configuration YAML online

You can edit your build config in yml format in the bitrise.yml editor. To do so, open the Workflow Editor and select Configuration YAML from the left navigation menu.

Managing an app's bitrise.yml configuration

You can edit the file directly here. Bitrise validates your configuration: if your bitrise.yml file is not valid, you won't be able to save the file.

To download the current bitrise.yml file, click Download. Alternatively, you can simply select certain sections of the file and copy those into either a local bitrise.yml file or into another project's bitrise.yml file.

Editing the configuration YAML locally

Our YAML scheme is shared on schemastore. This means that syntax highlight and auto-completion is available for the following files if you edit them locally:

  • bitrise.yml

  • step.yml

  • bitrise.json

The following editors support the auto-complete feature:

  • IntelliJ IDEA

  • PhpStorm

  • PyCharm

  • Rider

  • RubyMine

  • Visual Studio 2013+

  • Visual Studio Code

  • Visual Studio for Mac

  • WebStorm

  • JSONBuddy

    autocomplete.png

After editing your file locally, you can either copy its contents to the online bitrise.yml file or you can store it in your own repository.

In this section:

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.

A Step is a block of script execution that encapsulates a build task on Bitrise: the code to perform that task, the inputs and parameters you can define for the task, and the outputs the task generates.