BX CI
CI configuration for Amdocs Bill Experience projects
**/bxci.yaml**/bxci.yml
Validate
Check your file against this schema
Opens the validator with this schema already loaded. Paste your
**/bxci.yaml and it validates in your browser — nothing is uploaded.
Reference
Fields
Generated directly from the schema, following local
$refs, to two levels of nesting.
| Field | Type | Description |
|---|---|---|
projectrequired | object | Project properties |
project.name | string | Project's name (used by Jenkins, Docker and Sonar) |
project.type | enum | Project type default: "mvn"one of: "npm", "maven", "mvn" |
project.settings | string | ID of a managed maven or npm Jenkins file |
config | object | — |
config.jenkins_runtime | object | — |
config.jenkins_runtime.dockerrequired | object | Specifies how to build the Docker container (from an existing image or from a local Dockerfile) |
config.branch | object | Describes on which branch names a build will be run |
config.branch.branch_pattern | string | Regular expression for validating branch names |
config.branch.disable_validation | boolean | Disables branch name validation default: false |
config.build | object | — |
config.build.clean_workspace_after_run | boolean | Whether Jenkins workspace should be cleaned after the build default: true |
config.build.commit_time_threshold | oneOf | Commit age threshold. Disables automated builds older than this parameter. When 0, this feature is disabled default: false |
config.build.checkmarx | object | — |
config.build.static_analysis | object | — |
config.cache | object | Cache configuration for projects built inside Docker containers |
config.cache.repository | object | Binary repository details |
config.cache.items | array | List of cache types |
services | array | Additional services required by the project or application. |
environment | object | Custom environment variables to be added to the pipeline |
jenkinsEnvironment | array<string> | Jenkins environment variables that are passed to the Docker container |
stages | object | Defines the stages and steps required to build the project. |
output | object | Describes artifacts generated after all the stages have been run |
output.package | object | — |
output.package.publishrequired | array | — |
output.docker | object | — |
output.docker.imagesrequired | array | — |
output.docker.publish | array | — |
output.docker.multiArch | object | — |
output.helm | object | — |
output.helm.charts | array | — |
output.helm.publishrequired | array | — |
archive | array | List of artifacts to archive (wildcards allowed). Check out https://www.jenkins.io/doc/pipeline/steps/core/#archiveartifacts-archive-the-artifacts |
timeout | integer | Timeout in seconds |
Audit
What we found in this schema
- Declared draft: draft-07
- Validates cleanly against its own meta-schema.
- Has 4 place(s) where keywords sit beside
$ref. Under draft-07 those keywords are silently ignored by every conforming validator — first at#/definitions/checkmarx/properties/branch_pattern. - 124 properties, 74% carrying a description, max nesting depth 9.
Standards
Specification sections for the keywords in this schema
| Keyword | Document | Section |
|---|---|---|
$ref | JSON Schema Core, draft 2020-12 | §8.2.3.1 — Direct References with "$ref" |
additionalProperties | JSON Schema Core, draft 2020-12 | §10.3.2.3 — "additionalProperties" |
anyOf | JSON Schema Core, draft 2020-12 | §10.2.1.2 — "anyOf" |
default | JSON Schema Validation, draft 2020-12 | §9.2 — "default" |
description | JSON Schema Validation, draft 2020-12 | §9.1 — "title" and "description" |
enum | JSON Schema Validation, draft 2020-12 | §6.1.2 — "enum" |
examples | JSON Schema Validation, draft 2020-12 | §9.5 — "examples" |
format | JSON Schema Validation, draft 2020-12 | §7 — Vocabularies for Semantic Content With "format" |
items | JSON Schema Core, draft 2020-12 | §10.3.1.2 — "items" |
oneOf | JSON Schema Core, draft 2020-12 | §10.2.1.3 — "oneOf" |
pattern | JSON Schema Validation, draft 2020-12 | §6.3.3 — "pattern" |
patternProperties | JSON Schema Core, draft 2020-12 | §10.3.2.2 — "patternProperties" |
properties | JSON Schema Core, draft 2020-12 | §10.3.2.1 — "properties" |
required | JSON Schema Validation, draft 2020-12 | §6.5.3 — "required" |
type | JSON Schema Validation, draft 2020-12 | §6.1.1 — "type" |
uniqueItems | JSON Schema Validation, draft 2020-12 | §6.4.3 — "uniqueItems" |
format: "uri" | RFC 3986 (STD 66) | §3 — Syntax Components |
Documents
- JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
- JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
- RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
- RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.
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.