schema stringclasses 471
values | key stringlengths 0 203 | description stringlengths 0 4.37k | object stringlengths 2 322k |
|---|---|---|---|
bxci.schema-2.x.json | filterPattern | Defines the include/exclude wildcard patterns. Does not have effect when "exclusionsSetting" is set to "global" | {"type": "string", "examples": ["\"!**/_cvs/**/*, !**/.svn/**/*, !**/.hg/**/*, !**/.git/**/*\""]} |
bxci.schema-2.x.json | hideDebugLogs | Sets whether debug logs are visible in the job output | {"type": "boolean", "default": true} |
bxci.schema-2.x.json | waitForResultsEnabled | Sets whether the scan should be executed synchronously (default). The Synchronous mode allows viewing scan results in Jenkins | {"type": "boolean", "default": true} |
bxci.schema-2.x.json | vulnerabilityThresholdEnabled | Sets whether the scan should fail if the number of vulnerabilities is above the configured thresholds. This option is only available if the waitForResultsEnabled parameter is enabled | {"type": "boolean", "default": true} |
bxci.schema-2.x.json | highThreshold | Sets the maximum number of High vulnerabilities allowed | {"type": "integer", "default": 0} |
bxci.schema-2.x.json | mediumThreshold | Sets the maximum number of Medium vulnerabilities allowed | {"type": "integer", "default": 10} |
bxci.schema-2.x.json | lowThreshold | Sets the maximum number of Low vulnerabilities allowed | {"type": "integer", "default": null} |
bxci.schema-2.x.json | breaks_build | Waits for analysis result and breaks the build when the project fails for some quality gates | {"type": "boolean", "default": false} |
bxci.schema-2.x.json | branch_analysis | Indicates whether sonnar server supports branch analysis, to provide dedicated parameters. | {"type": "boolean", "default": true} |
bxci.schema-2.x.json | branch_pattern | Indicates what branches static analysis will be performed. | {"type": "string", "examples": ["^master$|^release/.+$", "master"]} |
bxci.schema-2.x.json | image | Prebuilt Docker image for running scan into it. If not specified, it will use the same image used for main build. | {"type": "string", "examples": ["myrepo:port/my-awesome-image:1.2.3"]} |
bxci.schema-2.x.json | timeout | Seconds to wait for the result of the quality gate. Only applies when breaks_build is set to true | {"default": 120} |
bxci.schema-2.x.json | exclusions | Comma separated list of wildcard patterns defining files to be excluded from the SonarQube scan | {"type": "string", "examples": ["**/excluded-folder/**, **/example/*.html"]} |
bxci.schema-2.x.json | when | Condition that should be met to run this step | {"type": "object", "properties": {"branch": {}}} |
bxci.schema-2.x.json | steps | List of steps to run | {"type": "array"} |
bxci.schema-2.x.json | failFast | Forces parallel stages to all be aborted when one of them fails | {"type": "boolean", "default": false} |
bxci.schema-2.x.json | parallel | List of stages to be executed in parallel | {"type": "object", "patternProperties": {"^\\w+( \\w+)*$": {}}} |
bxci.schema-2.x.json | ^\w+( \w+)*$ | Stage name in the Jenkins pipeline | {} |
bxci.schema-2.x.json | releaseChannel | Release channel name | {"type": "string"} |
bxci.schema-2.x.json | releaseChannelBranch | Indicates on which branches the artifact will be published | {} |
bxci.schema-2.x.json | dockerfile | Dockerfile path | {"type": "string"} |
bxci.schema-2.x.json | dockerfile | Path to Dockerfile used to generate the docker image | {} |
bxci.schema-2.x.json | image_name | Image name for the generated docker image. Cannot include tag. Tag will be automatically generated based on project version. | {"type": "string"} |
bxci.schema-2.x.json | publish | Docker publishing information. If not present, no images will be published | {} |
bxci.schema-2.x.json | vulnerability_scan | Configuration for running vulnerability scans on published Docker images | {"type": "object", "properties": {"enabled": {"type": "boolean", "default": true}}, "additionalProperties": false} |
bxci.schema-2.x.json | enabled | Whether the vulnerability scan step should be run | {"type": "boolean", "default": true} |
bxci.schema-2.x.json | args | List of build args (--build-arg) to pass in docker build | {"type": "array", "items": {}} |
bxci.schema-2.x.json | key | ARG name | {"type": "string"} |
bxci.schema-2.x.json | env | Environment variable whose value will be used to set the ARG | {"type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$"} |
bxci.schema-2.x.json | value | Value of the ARG | {"type": "string"} |
bxci.schema-2.x.json | registry | Docker registry. Must include protocol (http|https) and port | {"type": "string", "format": "uri"} |
bxci.schema-2.x.json | credentials | Jenkins credentials ID for publishing into the specified Docker registry | {} |
bxci.schema-2.x.json | path | Path to the folder with all required chart config files | {"type": "string"} |
bxci.schema-2.x.json | updates | Updates that must be done before packing Helm chart. It's a list of objects that specifies which updates must be done on which files | {"type": "array", "items": {}} |
bxci.schema-2.x.json | publish | Helm chart publishing configuration. If not present, no charts will be published | {} |
bxci.schema-2.x.json | file | Name (including path from Helm object path) of the file to be updated. Only supports yaml files | {"type": "string"} |
bxci.schema-2.x.json | properties | A list of properties to update. It can be updated with a fixed value or environment variable | {"type": "array", "items": {}} |
bxci.schema-2.x.json | key | Yaml property (full path) to be updated | {"type": "string"} |
bxci.schema-2.x.json | env | Environment variable whose value will be used to update the property | {"type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$"} |
bxci.schema-2.x.json | value | Value to update the given property | {"type": "string"} |
bxci.schema-2.x.json | repository | Helm chart repository. Must include protocol, host, port (if needed) and path | {"type": "string", "format": "uri"} |
bxci.schema-2.x.json | credentials | Jenkins credentials Id for this repository for uploading the chart | {} |
bxci.schema-2.x.json | publish | Package publish configuration. | {} |
bxci.schema-2.x.json | registry | NPM registry (env variable or registry URL) | {"type": "string", "examples": ["NPM_PUBLISH_REGISTRY", "NPM_SNAPSHOT_REGISTRY", "https://registry.npmjs.org"]} |
bxci.schema-2.x.json | credentials | Jenkins credentials ID for publishing into the specified Docker registry | {} |
bxci.schema-2.x.json | maven_releases_repo | Maven repository for deploying releases | {"type": "string"} |
bxci.schema-2.x.json | maven_snapshots_repo | Maven repository for deploying snapshots | {"type": "string"} |
bxci.schema-2.x.json | params | Optional params for npm publish or mvn deploy command. | {"type": "string", "examples": ["--tag latest", "-Dmaven.test.skip=true"]} |
bxci.schema-2.x.json | type | Cache type | {"enum": ["maven", "npm", "local"], "default": "maven"} |
bxci.schema-2.x.json | enabled | Sets whether this cache type is enabled | {"type": "boolean", "default": false} |
bxci.schema-2.x.json | source | Location of the cache in the Jenkins workspace | {"type": "string", "default": ".ci-cache/<type>"} |
bxci.schema-2.x.json | target | Location of the cache directory inside the Docker container | {"type": "string", "default": "/container-path/directory"} |
bxci.schema-2.x.json | project | Project properties | {"type": "object", "properties": {"name": {"type": "string"}, "type": {"enum": ["npm", "maven", "mvn"], "default": "mvn"}, "settings": {"type": "string", "examples": ["bx-maven-settings", "bx-npm-settings"]}}, "additionalProperties": false} |
bxci.schema-2.x.json | name | Project's name (used by Jenkins, Docker and Sonar) | {"type": "string"} |
bxci.schema-2.x.json | type | Project type | {"enum": ["npm", "maven", "mvn"], "default": "mvn"} |
bxci.schema-2.x.json | settings | ID of a managed maven or npm Jenkins file | {"type": "string", "examples": ["bx-maven-settings", "bx-npm-settings"]} |
bxci.schema-2.x.json | docker | Specifies how to build the Docker container (from an existing image or from a local Dockerfile) | {"type": "object", "properties": {"image": {"type": "string", "examples": ["remote-host.com/image-name:tag"]}, "dockerfile": {"examples": [".ci/Dockerfile"]}}, "additionalProperties": false} |
bxci.schema-2.x.json | image | Prebuilt Docker image (has precedence over dockerfile) | {"type": "string", "examples": ["remote-host.com/image-name:tag"]} |
bxci.schema-2.x.json | dockerfile | Path to a local Dockerfile | {"examples": [".ci/Dockerfile"]} |
bxci.schema-2.x.json | branch | Describes on which branch names a build will be run | {"type": "object", "properties": {"branch_pattern": {}, "disable_validation": {"type": "boolean", "default": false}}, "additionalProperties": false} |
bxci.schema-2.x.json | disable_validation | Disables branch name validation | {"type": "boolean", "default": false} |
bxci.schema-2.x.json | clean_workspace_after_run | Whether Jenkins workspace should be cleaned after the build | {"type": "boolean", "default": true} |
bxci.schema-2.x.json | commit_time_threshold | Commit age threshold. Disables automated builds older than this parameter. When 0, this feature is disabled | {"oneOf": [{"type": "integer", "const": 0}, {"type": "string", "pattern": "^\\d+[mhd]$"}], "default": false, "examples": [0, "2m", "30m", "1d", "30m", "10d"]} |
bxci.schema-2.x.json | checkmarx | Adds a Static Analysis stage for CheckMarx. See https://www.jenkins.io/doc/pipeline/steps/checkmarx/ for all the configuration options. | {} |
bxci.schema-2.x.json | static_analysis | Adds a Static Analysis stage for Sonar. | {} |
bxci.schema-2.x.json | cache | Cache configuration for projects built inside Docker containers | {"type": "object", "properties": {"repository": {}, "items": {"type": "array", "items": {}}}, "additionalProperties": false} |
bxci.schema-2.x.json | items | List of cache types | {"type": "array", "items": {}} |
bxci.schema-2.x.json | services | Additional services required by the project or application. | {"type": "array", "items": {"enum": ["Postgres", "Postgis", "Redis", "Mssql", "Mysql", "Mongodb", "Elasticsearch"]}, "uniqueItems": true} |
bxci.schema-2.x.json | environment | Custom environment variables to be added to the pipeline | {"type": "object", "propertyNames": {"pattern": "^[A-Za-z_][A-Za-z0-9_]*$"}} |
bxci.schema-2.x.json | jenkinsEnvironment | Jenkins environment variables that are passed to the Docker container | {"type": "array", "uniqueItems": true, "items": {"pattern": "^[A-Za-z_][A-Za-z0-9_]*$", "type": "string"}} |
bxci.schema-2.x.json | stages | Defines the stages and steps required to build the project. | {"type": "object", "patternProperties": {"^\\w+( \\w+)*$": {}}} |
bxci.schema-2.x.json | ^\w+( \w+)*$ | Stage name in the Jenkins pipeline | {} |
bxci.schema-2.x.json | output | Describes artifacts generated after all the stages have been run | {"type": "object", "properties": {"package": {}, "docker": {}, "helm": {}}, "additionalProperties": false} |
bxci.schema-2.x.json | package | Configuration for publishing NPM or Maven packages | {} |
bxci.schema-2.x.json | docker | Configuration for generating a Docker image | {} |
bxci.schema-2.x.json | helm | Configuration for generating a Helm chart | {} |
bxci.schema-2.x.json | archive | List of artifacts to archive (wildcards allowed). Check out https://www.jenkins.io/doc/pipeline/steps/core/#archiveartifacts-archive-the-artifacts | {"type": "array", "examples": ["target/*.jar", "**/*.jar", "target/out.txt"]} |
bxci.schema-2.x.json | timeout | Build timeout in seconds | {"default": 600} |
samt.json | source | Path to the source directory, defaults to ./src | {"type": "string", "format": "uri-reference"} |
samt.json | repositories | The default repositories to use if no repository is specified for a plugin | {"type": "object", "properties": {"maven": {"type": "string", "format": "uri"}}, "additionalProperties": false} |
samt.json | maven | The url to the maven repository to use, defaults to https://repo.maven.apache.org/maven2 | {"type": "string", "format": "uri"} |
samt.json | items | A local plugin, should most likely not be used in production | {"type": "object", "required": ["type", "path"], "properties": {"type": {"const": "local"}, "path": {"type": "string", "format": "uri-reference"}}, "additionalProperties": false} |
samt.json | items | A maven plugin in POM-like notation, will be downloaded from the provided repository | {"type": "object", "required": ["type", "groupId", "artifactId", "version"], "properties": {"type": {"const": "maven"}, "groupId": {"type": "string"}, "artifactId": {"type": "string"}, "version": {"type": "string"}, "repository": {"type": "string", "format": "uri"}}, "additionalProperties": false} |
samt.json | items | A maven plugin in gradle-like notation, will be downloaded from the provided repository | {"type": "object", "required": ["type", "dependency"], "properties": {"type": {"const": "gradle"}, "dependency": {"type": "string"}, "repository": {"type": "string", "format": "uri"}}, "additionalProperties": false} |
samt.json | generators | Which SAMT generators to use | {"type": "array", "items": {"type": "object", "required": ["name"], "properties": {"name": {"type": "string"}, "output": {"type": "string", "format": "uri-reference"}, "options": {"type": "object", "additionalProperties": {"type": "string"}}}, "additionalProperties": false}} |
meta.schema.json | A collection of definitions that make up a schema or a data model. | {"$defs": {"AliasPredicateEnum": {"enum": ["EXACT_SYNONYM", "RELATED_SYNONYM", "BROAD_SYNONYM", "NARROW_SYNONYM"], "type": "string"}, "AltDescription": {"additionalProperties": false, "properties": {"source": {"type": "string"}}, "required": ["source", "description"], "type": "object"}, "AltDescription__identifier_opti... | |
meta.schema.json | AliasPredicateEnum | permissible values for the relationship between an element and an alias | {"enum": ["EXACT_SYNONYM", "RELATED_SYNONYM", "BROAD_SYNONYM", "NARROW_SYNONYM"], "type": "string"} |
meta.schema.json | AltDescription | an attributed description | {"additionalProperties": false, "properties": {"source": {"type": "string"}}, "required": ["source", "description"], "type": "object"} |
meta.schema.json | description | text of an attributed description | {"type": "string"} |
meta.schema.json | source | the source of an attributed description | {"type": "string"} |
meta.schema.json | AltDescription__identifier_optional | an attributed description | {"additionalProperties": false, "properties": {"source": {"type": "string"}}, "required": ["description"], "type": "object"} |
meta.schema.json | description | text of an attributed description | {"type": "string"} |
meta.schema.json | source | the source of an attributed description | {"type": "string"} |
meta.schema.json | Annotation | a tag/value pair with the semantics of OWL Annotation | {"additionalProperties": false, "properties": {"annotations": {"additionalProperties": {}, "type": "object"}, "extensions": {"additionalProperties": {}, "type": "object"}, "tag": {"type": "string"}, "value": {"type": "string"}}, "required": ["tag", "value"], "type": "object"} |
meta.schema.json | annotations | a collection of tag/text tuples with the semantics of OWL Annotation | {"additionalProperties": {}, "type": "object"} |
meta.schema.json | extensions | a tag/text tuple attached to an arbitrary element | {"additionalProperties": {}, "type": "object"} |
meta.schema.json | tag | a tag associated with an extension | {"type": "string"} |
meta.schema.json | value | the actual annotation | {"type": "string"} |
meta.schema.json | Annotation__identifier_optional | a tag/value pair with the semantics of OWL Annotation | {"additionalProperties": false, "properties": {"annotations": {"additionalProperties": {}, "type": "object"}, "extensions": {"additionalProperties": {}, "type": "object"}, "tag": {"type": "string"}, "value": {"type": "string"}}, "required": ["value"], "type": "object"} |
meta.schema.json | annotations | a collection of tag/text tuples with the semantics of OWL Annotation | {"additionalProperties": {}, "type": "object"} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.