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-step
Schema registry

bitrise-step

Steps and Workflows are the heart of how Bitrise works. A Bitrise build is simply a series of Steps. 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

step.yml
Validate

Check your file against this schema

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

Validate a step.yml → View raw schema

Reference

Fields

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

Field Type Description
titlestringThe human-readable title of the Step.
summarystringA short summary of what the Step does.
descriptionstringA more detailed overview of the Step's function and configuration.
websitestringA web URL where users can find more information about the Step or the tools and services it implements.
source_code_urlstringThe URL of the repository of the Step's source code.
support_urlstringA URL where users can get support for the Step.
published_atstringThe date and time when the Step was published to the Step Library. This is auto-generated and should not be set manually.
sourceobject—
source.gitstringThe Git repository URL of the Step's source code.
source.commitstringThe commit hash for the version tag of the Step's current version.
asset_urlsobjectURLs of assets associated with the Step, such as icon images. This is auto-generated and only set in the spec.json file in the Step Library.
host_os_tagsarray<string>This property defines the host operating systems the Step is compatible with. For example, `linux` or `macos`.
project_type_tagsarray<string>This property defines the project type category of the Step. For example, `flutter` or `ios`.
type_tagsarray<string>This property defines the functional category of the Step. For example, `utility`, `test`, or `notification`.
dependenciesarrayThe dependencies required by the Step.
toolkitobject—
toolkit.bashobject—
toolkit.bash.entry_filestringThe path to the bash script file that serves as the entry point for the Step.
toolkit.goobject—
toolkit.go.package_namerequiredstringThe name of the Go package that serves as the entry point for the Step.
depsobject—
deps.brewarrayList of Homebrew dependencies required by the Step.
deps.apt_getarrayList of apt-get dependencies required by the Step.
deps.check_onlyarrayList of dependencies that are only checked for existence.
is_requires_admin_userbooleanIf this property is true, the Step requires admin user privileges to run.
is_always_runbooleanIf this property is true, the Step will always run, even if a previous Step in the Workflow failed.
is_skippablebooleanIf this property is true, the build won't fail even if this Step fails. For example, if a Step restoring a cache archive fails, you might still want to run the build.
run_ifstringThis property sets conditions for running a Step. It requires boolean value or a valid Go template expression.
timeoutintegerThis property defines a time limit for a Step: if the Step runs longer than the defined time, the Step fails. Define the limit in seconds.
no_output_timeoutintegerThis property defines a time limit for a Step that produces no output: if the Step runs for the defined number of seconds without producing any output, the Step fails. Define the limit in seconds.
metaobjectAdditional metadata related to the Step.
execution_containeroneOfA reference to a container. Can be specified as a container ID string or as an object with the container ID as the key and optional configuration as the value.
service_containersarrayService containers to run alongside this Step as background services.
inputsarray<object>The inputs of the Step.
outputsarray<object>The outputs the Step generates.
executablesobjectPlatform-specific executable binaries
Audit

What we found in this schema

Standards

Specification sections for the keywords in this schema

Keyword Document Section
$idJSON Schema Core, draft 2020-12§8.2.1 — The "$id" Keyword
$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"
itemsJSON Schema Core, draft 2020-12§10.3.1.2 — "items"
maxPropertiesJSON Schema Validation, draft 2020-12§6.5.1 — "maxProperties"
minPropertiesJSON Schema Validation, draft 2020-12§6.5.2 — "minProperties"
oneOfJSON Schema Core, draft 2020-12§10.2.1.3 — "oneOf"
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: "date-time"RFC 3339§5.6 — Internet Date/Time Format

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