Skip to content

bitrise.json and bitrise-step.json descriptions #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
godrei merged 23 commits into from
Mar 3, 2026
Merged

bitrise.json and bitrise-step.json descriptions #6

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
82243e2
descriptions for the Bitrise JSON schema
zoltan-baba May 8, 2025
8da9c30
removing urls temporarily
zoltan-baba May 8, 2025
2ea69e8
yaml descriptions added
zoltan-baba Jul 23, 2025
aee2ddd
Added more descriptions to bitrise.json
zoltan-baba Jan 19, 2026
47979a9
minor fixes
zoltan-baba Jan 20, 2026
af60a26
Merge branch 'bitrise-io:master' into master
zoltan-baba Jan 20, 2026
2440c1e
bitrise-step.json descriptions
zoltan-baba Jan 22, 2026
f2d0bec
Merge branch 'master' into master
godrei Jan 26, 2026
e611b15
Update descriptions in bitrise.json after review
zoltan-baba Jan 28, 2026
4ebbce0
Update descriptions in bitrise-step.json after review
zoltan-baba Jan 28, 2026
2fac13e
Update bitrise-step.json
godrei Feb 2, 2026
3dbbc6d
Update bitrise-step.json
godrei Feb 3, 2026
155f17c
Remove unused step schema propoerties
godrei Feb 3, 2026
55d18a4
Merge branch updates into zoli-master
godrei Feb 3, 2026
76a397e
format_version and triggers description update
zoltan-baba Feb 6, 2026
65839a6
Schema fixes
godrei Feb 27, 2026
9a9674e
Add step based containerisation fields
godrei Feb 27, 2026
f5aa307
Fix container schema
godrei Mar 3, 2026
6df1ab8
Improve steps' json schema and sync it with the bitrise.yaml json schema
godrei Mar 3, 2026
380044a
Remove step based containerisation properties
godrei Mar 3, 2026
43f986a
Use the same step schema for both bitrise.json and bitrise-step.json
godrei Mar 3, 2026
51a92c3
Remove new containerisation related schemas
godrei Mar 3, 2026
376e304
Resolve duplicated step schema
godrei Mar 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
137 changes: 91 additions & 46 deletions src/schemas/json/bitrise-step.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,12 @@
"AptGetDepModel": {
"properties": {
"name": {
"type": "string"
"type": "string",
"description": "The name of the package to be installed via apt-get."
},
"bin_name": {
"type": "string"
"type": "string",
"description": "The name of the binary."
Comment thread
zoltan-baba marked this conversation as resolved.
Outdated
}
},
"additionalProperties": false,
Expand All @@ -17,7 +19,8 @@
"BashStepToolkitModel": {
"properties": {
"entry_file": {
"type": "string"
"type": "string",
"description": "The path to the bash script file that serves as the entry point for the Step."
}
},
"additionalProperties": false,
Expand All @@ -26,10 +29,12 @@
"BrewDepModel": {
"properties": {
"name": {
"type": "string"
"type": "string",
"description": "The name of the package to be installed via Homebrew."
},
"bin_name": {
"type": "string"
"type": "string",
"description": "The name of the binary."
}
},
"additionalProperties": false,
Expand All @@ -38,7 +43,8 @@
"CheckOnlyDepModel": {
"properties": {
"name": {
"type": "string"
"type": "string",
"description": "The name of the dependency to be checked."
}
},
"additionalProperties": false,
Expand All @@ -47,10 +53,12 @@
"DependencyModel": {
"properties": {
"manager": {
"type": "string"
"type": "string",
"description": "The package manager used to handle the dependency."
},
"name": {
"type": "string"
"type": "string",
"description": "The name of the dependency."
}
},
"additionalProperties": false,
Expand All @@ -60,21 +68,27 @@
"properties": {
"brew": {
"items": {
"$ref": "#/definitions/BrewDepModel"
"$ref": "#/definitions/BrewDepModel",
"description": "A Homebrew dependency required by the Step."
},
"type": "array"
"type": "array",
"description": "List of Homebrew dependencies required by the Step."
},
"apt_get": {
"items": {
"$ref": "#/definitions/AptGetDepModel"
"$ref": "#/definitions/AptGetDepModel",
"description": "An apt-get dependency required by the Step."
},
"type": "array"
"type": "array",
"description": "List of apt-get dependencies required by the Step."
},
"check_only": {
Comment thread
zoltan-baba marked this conversation as resolved.
"items": {
"$ref": "#/definitions/CheckOnlyDepModel"
"$ref": "#/definitions/CheckOnlyDepModel",
"description": "A dependency that is only checked for existence."
},
"type": "array"
"type": "array",
"description": "List of dependencies that are only checked for existence."
}
},
"additionalProperties": false,
Expand All @@ -95,7 +109,8 @@
"required": ["package_name"],
"properties": {
"package_name": {
"type": "string"
"type": "string",
"description": "The name of the Go package that serves as the entry point for the Step."
}
},
"additionalProperties": false,
Expand All @@ -104,90 +119,112 @@
"StepModel": {
"properties": {
"title": {
"type": "string"
"type": "string",
"description": "The human-readable title of the Step."
},
"summary": {
"type": "string"
"type": "string",
"description": "A short summary of what the Step does."
},
"description": {
"type": "string"
"type": "string",
"description": "A more detailed overview of the Step's function and configuration."
},
"website": {
"type": "string"
"type": "string",
"description": "A web URL where users can find more information about the Step or the tools and services it implements."
},
"source_code_url": {
"type": "string"
"type": "string",
"description": "The URL of the repository of the Step's source code."
},
"support_url": {
"type": "string"
"type": "string",
"description": "A URL where users can get support for the Step."
},
"published_at": {
"type": "string",
"format": "date-time"
"format": "date-time",
"description": "The date and time when the Step was published."
},
"source": {
"$ref": "#/definitions/StepSourceModel"
"$ref": "#/definitions/StepSourceModel",
"description": "The source code repository and commit information of the Step."
},
"asset_urls": {
Comment thread
zoltan-baba marked this conversation as resolved.
"patternProperties": {
".*": {
"type": "string"
"type": "string",
"description": "The URL of an asset required by the Step."
}
},
"type": "object"
},
"host_os_tags": {
"items": {
"type": "string"
"type": "string",
"description": "The host operating system tag."
},
"type": "array"
"type": "array",
"description": "This property defines the host operating systems the Step is compatible with. For example, `linux` or `macos`."
},
"project_type_tags": {
"items": {
"type": "string"
"type": "string",
"description": "The project type tag."
},
"type": "array"
"type": "array",
"description": "This property defines the project type category of the Step. For example, `flutter` or `ios`."
},
"type_tags": {
"items": {
"type": "string"
},
"type": "array"
"type": "array",
"description": "This property defines the project type category of the Step. For example, `flutter` or `ios`."
Comment thread
zoltan-baba marked this conversation as resolved.
Outdated
},
"dependencies": {
"items": {
"$ref": "#/definitions/DependencyModel"
},
"type": "array"
"type": "array",
"description": "The dependencies required by the Step."
},
"toolkit": {
"$ref": "#/definitions/StepToolkitModel"
"$ref": "#/definitions/StepToolkitModel",
"description": "The toolkit used by the Step."
},
"deps": {
"$ref": "#/definitions/DepsModel"
"$ref": "#/definitions/DepsModel",
Comment thread
zoltan-baba marked this conversation as resolved.
},
"is_requires_admin_user": {
"type": "boolean"
"type": "boolean",
"description": "If this property is true, the Step requires admin user privileges to run."
Comment thread
godrei marked this conversation as resolved.
},
"is_always_run": {
"type": "boolean"
"type": "boolean",
"description": "If this property is true, the Step will always run, even if a previous Step in the Workflow failed."
},
"is_skippable": {
"type": "boolean"
"type": "boolean",
"description": "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": {
"type": "string"
"type": "string",
"description": "This property sets conditions for running a Step. It requires a valid Go template expression."
Comment thread
zoltan-baba marked this conversation as resolved.
Outdated
},
"timeout": {
"type": "integer"
"type": "integer",
"description": "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."
},
"meta": {
"patternProperties": {
".*": {
"additionalProperties": true
}
},
"type": "object"
"type": "object",
"description": "Metadata related to the Step."
Comment thread
zoltan-baba marked this conversation as resolved.
Outdated
},
"inputs": {
"items": {
Expand All @@ -196,9 +233,11 @@
"additionalProperties": true
}
},
"type": "object"
"type": "object",
"description": "An input parameter of the Step."
},
"type": "array"
"type": "array",
"description": "The inputs of the Step."
},
"outputs": {
"items": {
Expand All @@ -207,9 +246,11 @@
"additionalProperties": true
}
},
"type": "object"
"type": "object",
"description": "An output parameter of the Step."
},
"type": "array"
"type": "array",
"description": "The outputs the Step generates."
},
"executables": {
"description": "Platform-specific executable binaries",
Expand All @@ -225,10 +266,12 @@
"StepSourceModel": {
"properties": {
"git": {
"type": "string"
"type": "string",
"description": "The Git repository URL of the Step's source code."
},
"commit": {
"type": "string"
"type": "string",
"description": "The specific commit hash of the Step's source code."
Comment thread
zoltan-baba marked this conversation as resolved.
Outdated
}
},
"additionalProperties": false,
Expand All @@ -237,10 +280,12 @@
"StepToolkitModel": {
"properties": {
"bash": {
"$ref": "#/definitions/BashStepToolkitModel"
"$ref": "#/definitions/BashStepToolkitModel",
"description": "The Bash toolkit configuration for the Step."
},
"go": {
"$ref": "#/definitions/GoStepToolkitModel"
"$ref": "#/definitions/GoStepToolkitModel",
"description": "The Go toolkit configuration for the Step."
}
},
"additionalProperties": false,
Expand Down
Loading