Step properties ⚓
Step properties provide important data of a Step, such as its project type, its source code or the dependencies it requires. A Step’s inputs and outputs are also defined as step properties. Let’s take a look at the properties!
description: metadata, for comments, tools and GUI. Note: these meta properties can be used for permanent comments. Standard YML comments are not preserved when the YML is normalized, converted to JSON or otherwise generated or transformed. These meta properties are.
website: official website of the Step / service.
source_code_url: the url where the Step’s source code can be viewed.
support_url: url to the Step’s support / issue tracker.
published_at: auto-generated at share - the StepLib publish date of the Step’s version
source: auto-generated at share git clone information.
asset_urls: auto-generated at share Step assets (StepLib specific), like icon image.
host_os_tags: supported operating systems. Currently unused, reserved for future use.
project_type_tags: project type tags if the Step is project type specific. Example:
android. Completely optional, and only used for search and filtering in Step lists.
type_tags: generic type tags related to the Step. Example:
notification. Similar to
project_type_tags, this property is completely optional, and only used for search and filtering in Step lists.
deps: specifies the required dependencies of the Step. To declare a dependency, specify a package manager and then the dependency you wish to install.
yaml deps: brew: - name: curl - name: git
inputs: inputs (Environments) of the Step. For more info, see Step inputs.
outputs: outputs (Environments) of the Step. For more info, see Step outputs.
The configuration format of the Bitrise CLI is referred to as bitrise.yml. This is the expected file name the configuration should be saved with.
Any tool that can edit `bitrise.yml` can add custom properties to it. This way you can add special properties or notes to your env vars, or even try new configurations...
To understand Bitrise in depth, there are a few key concepts that must be kept in mind. These are immutable and crucial to the way we do things.