Formatter Validator Minifier Escape / Unescape JSON ↔ String JSON ↔ YAML JSON → CSV NDJSON / JSON Lines JSON → Types JSON ↔ XML JSON Diff JSON Patch Canonicalize (RFC 8785) Schema Validator Schema Generator JSONPath Tester JWT Decoder JSON Errors Schemas More Tools
JSONTools / Schema registry / bitrise
Schema registry

bitrise

The configuration format of the Bitrise CLI. Bitrise is a collection of tools and services to help you with the development and automation of your software projects, with a main focus on mobile apps

bitrise.ymlbitrise.yamlbitrise.json
Validate

Check your file against this schema

Opens the validator with this schema already loaded. Paste your bitrise.yml and it validates in your browser — nothing is uploaded.

Validate a bitrise.yml → View raw schema

Reference

Fields

Generated directly from the schema, following local $refs, to two levels of nesting.

Field Type Description
format_versionstringThe version of the Bitrise configuration format. The Bitrise CLI checks it to ensure compatibility between the configuration file and the CLI version. This is relevant for locally run builds: on the Bitrise website, the CLI is always up to
default_step_lib_sourcestringThe default Step library for the Steps used in your configuration. Bitrise uses this source if no specific source is provided for a given Step.
project_typestringThe type of your Bitrise project, such as ios, android, flutter, and so on.
titlestringThe title of the Bitrise configuration.
summarystringA short summary of the Bitrise configuration.
descriptionstringA detailed description of the Bitrise configuration.
servicesobjectDocker container definitions used by Steps as service containers.
containersobjectDocker container definitions used by Steps as execution containers.
appobject—
app.titlestringThe title of the project.
app.summarystringA short summary of the project.
app.descriptionstringA detailed description of the project.
app.status_report_namestringThe name that will appear on the status report sent to connected services (like GitHub, GitLab, Bitbucket, etc.) after the build is finished.
app.envsarray<object>A list of Environment Variables.
metaobjectStores project metadata key-value pairs related to the Bitrise configuration. Most importantly, it defines the default stack and the build machine type for the project.
trigger_maparrayDefines the build triggers on a project level. This is the legacy method of configuring triggers: we recommend using target-based triggers defined as part of a Pipeline or a Workflow instead.
pipelinesobjectDefine Pipelines in your project's configuration. Pipelines can be used to organize the entire CI/CD process and to set up advanced configurations with multiple different tasks running parallel and/or sequentially.
stagesobjectDefines Stages in your configuration. A Stage is a collection of Workflows that are executed sequentially as part of a Pipeline.
workflowsobjectThe Workflows included in your configuration. A Workflow is a collection of Steps: reusable, configurable units of work. Steps are executed sequentially within a Workflow.
step_bundlesobjectStep bundles allow you to group multiple Steps into a single unit. With Step bundles, you can reuse Steps and sequences of Steps.
toolsobjectMapping of tool IDs to versions to set up. Version syntax supports exact versions (e.g. '1.2.3'), partial matches to the latest release (e.g. '22:latest'), partial matches to installed versions (e.g. '1.2:installed'), as well as the
tool_configobject—
tool_config.providerstringTool provider to use for setup. Defaults to 'asdf' if not specified.
one of: "asdf", "mise"
tool_config.extra_pluginsobjectAdditional tool plugins beyond Bitrise's vetted and tested integrations for common tools. Maps tool IDs to asdf plugin repository URLs.
includearrayThe `include` property allows you to use other configuration YAML files in your Bitrise configuration, to break down large, complex YAML files into smaller, modular components.
Audit

What we found in this schema

Standards

Specification sections for the keywords in this schema

Keyword Document Section
$refJSON Schema Core, draft 2020-12§8.2.3.1 — Direct References with "$ref"
$schemaJSON Schema Core, draft 2020-12§8.1.1 — "$schema"
additionalPropertiesJSON Schema Core, draft 2020-12§10.3.2.3 — "additionalProperties"
descriptionJSON Schema Validation, draft 2020-12§9.1 — "title" and "description"
enumJSON Schema Validation, draft 2020-12§6.1.2 — "enum"
itemsJSON Schema Core, draft 2020-12§10.3.1.2 — "items"
minLengthJSON Schema Validation, draft 2020-12§6.3.2 — "minLength"
oneOfJSON Schema Core, draft 2020-12§10.2.1.3 — "oneOf"
patternJSON Schema Validation, draft 2020-12§6.3.3 — "pattern"
patternPropertiesJSON Schema Core, draft 2020-12§10.3.2.2 — "patternProperties"
propertiesJSON Schema Core, draft 2020-12§10.3.2.1 — "properties"
requiredJSON Schema Validation, draft 2020-12§6.5.3 — "required"
typeJSON Schema Validation, draft 2020-12§6.1.1 — "type"
format: "uri"RFC 3986 (STD 66)§3 — Syntax Components

Documents

Source

Attribution

This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.

← All schemas