zBuilder YAML schema reference
This section provides a detailed YAML schema reference for zBuilder configuration, which is divided into two configuration aspects:
- Build Configuration
- Application Configuration
Schema version
All zBuilder YAML files require the version property to be set. The current schema version is:
version: 1.0.0
Build configuration
The main build configuration file for the zBuilder is dbb-build.yaml. This file is shipped with the DBB toolkit and can be relocated to a Git repository under the control of the build engineer. Include statements allow large build
configurations to be split into smaller YAML files.
All build configuration files are required to have at least one of the following top-level keywords:
| Keyword | Description |
|---|---|
include: |
Use the include keyword to import and merge build configuration from other YAML files. |
variables: |
Define zBuilder variables to customize the behavior of build and task execution |
lifecycles: |
Create lifecycles which are named build definitions that define different types of builds and can be executed from the command line. |
tasks: |
Global area to declare and configure tasks that can then be used in multiple lifecycles. |
Application configuration
Application configuration provides a mechanism to allow applications being built by zBuilder to override default build configurations. Application configuration is defined by the dbb-app.yaml file located in the application
root directory.
| Keyword | Description |
|---|---|
application: |
All application configuration belong to the top-level application keyword. |
Schema JSON files
To get syntax highlighting and validation when editing zBuilder YAML files, add the buildConfigurationSchema.json and applicationConfigurationSchema.json zBuilder YAML schema files to your IBM Developer for z/OS Eclipse
or VS Code editors. These YAML schema files are available in the DBB installation on z/OS Unix at /usr/lpp/IBM/dbb/samples/schema.
You can also download them as .zip files by clicking the following links:
See Setting up a zBuilder YAML development environment for information on how to use them.
Legacy Schema
These configuration schema will be updated to the latest version of DBB schema upon release. This will not introduce changes that break your configuration files as older versions will be subsets of newer versions, but if your version of DBB is not updated, this schema may support changes your runtime environment cannot use yet. If there does not exist a legacy schema for an older version of DBB, it is because the schema was not updated in since its last release.