latest--bitrise-step

shared
Type StepModel
Schema URL https://catalog.lintel.tools/schemas/schemastore/bitrise/_shared/latest--bitrise-step.json
Parent schema bitrise
Type: StepModel

Definitions

AptGetDepModel object
name string

The name of the package to be installed via apt-get.

bin_name string

The name of the binary. This is optional and can be used if the binary name differs from the package name.

BashStepToolkitModel object
entry_file string

The path to the bash script file that serves as the entry point for the Step.

BrewDepModel object
name string

The name of the package to be installed via Homebrew.

bin_name string

The name of the binary. This is optional and can be used if the binary name differs from the package name.

CheckOnlyDepModel object
name string

The name of the binary or tool to check for. If it is not present on the system, the Step will fail before running.

DependencyModel object
manager string

The package manager used to handle the dependency.

name string

The name of the dependency.

DepsModel object
brew BrewDepModel[]

List of Homebrew dependencies required by the Step.

apt_get AptGetDepModel[]

List of apt-get dependencies required by the Step.

check_only CheckOnlyDepModel[]

List of dependencies that are only checked for existence.

ExecutableModel object

Platform-specific executable binary.

storage_uri string

The URI where the executable binary is stored.

hash string

The hash of the executable binary for integrity verification.

GoStepToolkitModel object
package_name string required

The name of the Go package that serves as the entry point for the Step.

ContainerReferenceConfigModel object

Additional configuration for a container reference.

recreate boolean

If true, the current container instance is discarded and a fresh one is started for this Step.

ContainerReferenceModel string | object

A 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.

StepModel object
title string

The human-readable title of the Step.

summary string

A short summary of what the Step does.

description string

A more detailed overview of the Step's function and configuration.

website string

A web URL where users can find more information about the Step or the tools and services it implements.

source_code_url string

The URL of the repository of the Step's source code.

support_url string

A URL where users can get support for the Step.

published_at string

The date and time when the Step was published to the Step Library. This is auto-generated and should not be set manually.

format=date-time
source object
2 nested properties
git string

The Git repository URL of the Step's source code.

commit string

The commit hash for the version tag of the Step's current version.

asset_urls object

URLs 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_tags string[]

This property defines the host operating systems the Step is compatible with. For example, linux or macos.

project_type_tags string[]

This property defines the project type category of the Step. For example, flutter or ios.

type_tags string[]

This property defines the functional category of the Step. For example, utility, test, or notification.

dependencies DependencyModel[]

The dependencies required by the Step.

toolkit object
2 nested properties
bash object
1 nested properties
entry_file string

The path to the bash script file that serves as the entry point for the Step.

go object
1 nested properties
package_name string required

The name of the Go package that serves as the entry point for the Step.

deps object
3 nested properties
brew BrewDepModel[]

List of Homebrew dependencies required by the Step.

apt_get AptGetDepModel[]

List of apt-get dependencies required by the Step.

check_only CheckOnlyDepModel[]

List of dependencies that are only checked for existence.

is_requires_admin_user boolean

If this property is true, the Step requires admin user privileges to run.

is_always_run boolean

If this property is true, the Step will always run, even if a previous Step in the Workflow failed.

is_skippable boolean

If 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_if string

This property sets conditions for running a Step. It requires boolean value or a valid Go template expression.

timeout integer

This 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_timeout integer

This 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.

meta object

Additional metadata related to the Step.

execution_container string | object

A 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_containers ContainerReferenceModel[]

Service containers to run alongside this Step as background services.

inputs object[]

The inputs of the Step.

outputs object[]

The outputs the Step generates.

executables Record<string, object>

Platform-specific executable binaries

StepSourceModel object
git string

The Git repository URL of the Step's source code.

commit string

The commit hash for the version tag of the Step's current version.

StepToolkitModel object
bash object
1 nested properties
entry_file string

The path to the bash script file that serves as the entry point for the Step.

go object
1 nested properties
package_name string required

The name of the Go package that serves as the entry point for the Step.