@schemastore/bxci.schema-2.x 0.0.1 → 0.0.2

package/README.md

@@ -8,5 +8,5 @@ This package contains type definitions for bxci.schema-2.x.
 Files were exported from https://github.com/ffflorian/schemastore-updater/tree/main/schemas/bxci.schema-2.x.
 
 ## Additional Details
-* Last updated: Sat, Dec 17, 2022, 12:06:04 GMT
+* Last updated: Thu, Apr 27, 2023, 09:50:34 GMT
 * Dependencies: none

package/index.d.ts

@@ -1,4 +1,4 @@
-/* tslint:disable */
+/* eslint-disable */
 /**
  * This file was automatically generated by json-schema-to-typescript.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
@@ -9,12 +9,36 @@
  * Regular expression for validating branch names
  */
 export type BranchPattern = string;
+/**
+ * Stage name in the Jenkins pipeline
+ *
+ * This interface was referenced by `Stages`'s JSON-Schema definition
+ * via the `patternProperty` "^\w+( \w+)*$".
+ */
+export type Stage = (Stage1 | ParallelStage) & {
+  when?: When;
+  steps?: Steps;
+  fail_fast?: FailFast;
+  parallel?: Parallel;
+};
+/**
+ * List of steps to run
+ */
+export type Steps = unknown[];
+/**
+ * Regular expression for validating branch names
+ */
+export type Branch = string;
+/**
+ * Forces parallel stages to all be aborted when one of them fails
+ */
+export type FailFast = boolean;
 /**
  * Release channel name
  */
 export type ReleaseChannel = string;
 /**
- * Indicates on which branches the artifact will be published.
+ * Indicates on which branches the artifact will be published
  */
 export type ReleaseChannelBranch = string;
 /**
@@ -25,6 +49,31 @@ export type OutputPackagePublish = PackagePublishChannel[];
  * Docker publishing information. If not present, no images will be published
  */
 export type OutputDockerPublish = DockerReleaseChannel[];
+export type OutputDockerBuildArgs = {
+  /**
+   * ARG name
+   */
+  key: string;
+  /**
+   * Environment variable whose value will be used to set the ARG
+   */
+  env?: string;
+  /**
+   * Value of the ARG
+   */
+  value?: string;
+} & OutputDockerBuildArgs1;
+export type OutputDockerBuildArgs1 =
+  | {
+      [k: string]: unknown | undefined;
+    }
+  | {
+      [k: string]: unknown | undefined;
+    };
+/**
+ * List of build args (--build-arg) to pass in docker build
+ */
+export type DockerBuildArgs = OutputDockerBuildArgs[];
 export type OutputHelmUpdatesProperties = {
   /**
    * Yaml property (full path) to be updated
@@ -41,10 +90,10 @@ export type OutputHelmUpdatesProperties = {
 } & OutputHelmUpdatesProperties1;
 export type OutputHelmUpdatesProperties1 =
   | {
-      [k: string]: unknown;
+      [k: string]: unknown | undefined;
     }
   | {
-      [k: string]: unknown;
+      [k: string]: unknown | undefined;
     };
 /**
  * Helm chart publishing configuration. If not present, no charts will be published
@@ -103,14 +152,18 @@ export interface BxciSchema2 {
        * Whether Jenkins workspace should be cleaned after the build
        */
       clean_workspace_after_run?: boolean;
-      checkmarx?: Checkmarx;
+      /**
+       * Commit age threshold. Disables automated builds older than this parameter. When 0, this feature is disabled
+       */
+      commit_time_threshold?: 0 | string;
+      checkmarx?: CheckMarx;
       static_analysis?: Sonar;
     };
     /**
      * Cache configuration for projects built inside Docker containers
      */
     cache?: {
-      repository: BinaryRepository;
+      repository?: BinaryRepository;
       /**
        * List of cache types
        */
@@ -125,18 +178,13 @@ export interface BxciSchema2 {
    * Custom environment variables to be added to the pipeline
    */
   environment?: {
-    [k: string]: unknown;
+    [k: string]: unknown | undefined;
   };
   /**
    * Jenkins environment variables that are passed to the Docker container
    */
   jenkinsEnvironment?: string[];
-  /**
-   * Defines the stages and steps required to build the project.
-   */
-  stages: {
-    [k: string]: Stage;
-  };
+  stages: Stages;
   /**
    * Describes artifacts generated after all the stages have been run
    */
@@ -153,27 +201,85 @@ export interface BxciSchema2 {
    * Build timeout in seconds
    */
   timeout?: number;
-  [k: string]: unknown;
+  [k: string]: unknown | undefined;
 }
 /**
  * Adds a Static Analysis stage for CheckMarx. See https://www.jenkins.io/doc/pipeline/steps/checkmarx/ for all the configuration options.
  */
-export interface Checkmarx {
+export interface CheckMarx {
+  /**
+   * Sets whether the scan should be run
+   */
   enabled?: boolean;
+  /**
+   * Specifies in which branches this stage will be executed
+   */
+  branch_pattern?: string;
+  /**
+   * Fully qualified team name for the project
+   */
   groupId?: string;
+  /**
+   * Scan preset for the project
+   */
   preset?: string;
-  projectName?: string;
   /**
-   * Regular expression for validating branch names
+   * Language encoding ID associated to the source code character encoding (5: Multi-Language Scan)
+   */
+  sourceEncoding?: string;
+  /**
+   * Checkmarx Server URL or IP address
    */
-  branch_pattern?: string;
-  useOwnServerCredentials?: boolean;
   serverUrl?: string;
+  /**
+   * Jenkins credentials ID
+   */
   credentialsId?: string;
-  generatePdfReport?: boolean;
-  sourceEncoding?: string;
   isProxy?: boolean;
+  /**
+   * Enables the use of the default server credentials or disables and provides server and credentials that override the defaults
+   */
+  useOwnServerCredentials?: boolean;
+  /**
+   * Unique project name. Will be inferred from the repository name if not provided
+   */
+  projectName?: string;
+  /**
+   * Specifies which exclusions settings to use: global (Jenkins global settings) or job (current pipeline)
+   */
+  exclusionsSetting?: "job" | "global";
+  /**
+   * Comma separated list of folders to be excluded from the CxSAST scan
+   */
+  excludeFolders?: string;
+  /**
+   * Defines the include/exclude wildcard patterns. Does not have effect when "exclusionsSetting" is set to "global"
+   */
+  filterPattern?: string;
+  /**
+   * Sets whether debug logs are visible in the job output
+   */
+  hideDebugLogs?: boolean;
+  /**
+   * Sets whether the scan should be executed synchronously (default). The Synchronous mode allows viewing scan results in Jenkins
+   */
   waitForResultsEnabled?: boolean;
+  /**
+   * 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
+   */
+  vulnerabilityThresholdEnabled?: boolean;
+  /**
+   * Sets the maximum number of High vulnerabilities allowed
+   */
+  highThreshold?: number;
+  /**
+   * Sets the maximum number of Medium vulnerabilities allowed
+   */
+  mediumThreshold?: number;
+  /**
+   * Sets the maximum number of Low vulnerabilities allowed
+   */
+  lowThreshold?: number;
 }
 /**
  * Adds a Static Analysis stage for Sonar.
@@ -206,7 +312,7 @@ export interface CacheItem {
   /**
    * Cache type
    */
-  type: "maven" | "npm";
+  type: "maven" | "npm" | "local";
   /**
    * Sets whether this cache type is enabled
    */
@@ -221,27 +327,49 @@ export interface CacheItem {
   target?: string;
 }
 /**
- * Stage name in the Jenkins pipeline
- *
- * This interface was referenced by `undefined`'s JSON-Schema definition
+ * Defines the stages and steps required to build the project.
+ */
+export interface Stages {
+  [k: string]: Stage;
+}
+/**
+ * This interface was referenced by `Parallel`'s JSON-Schema definition
  * via the `patternProperty` "^\w+( \w+)*$".
  */
-export interface Stage {
-  /**
-   * List of steps to run
-   */
-  steps: unknown[];
+export interface Stage1 {
+  steps: Steps;
+  when?: When;
+}
+/**
+ * Condition that should be met to run this step
+ */
+export interface When {
+  branch?: Branch;
+  [k: string]: unknown | undefined;
+}
+export interface ParallelStage {
+  when?: When;
+  fail_fast?: FailFast;
   /**
-   * Condition that should be met to run this step
+   * List of stages to be executed in parallel
    */
-  when?: {
-    /**
-     * Specifies in which branches this stage will be executed
-     */
-    branch?: string;
-    [k: string]: unknown;
+  parallel: {
+    [k: string]: Stage2;
   };
 }
+/**
+ * Stage name in the Jenkins pipeline
+ *
+ * This interface was referenced by `undefined`'s JSON-Schema definition
+ * via the `patternProperty` "^\w+( \w+)*$".
+ */
+export interface Stage2 {
+  steps: Steps;
+  when?: When;
+}
+export interface Parallel {
+  [k: string]: Stage1;
+}
 /**
  * Configuration for publishing NPM or Maven packages
  */
@@ -274,6 +402,7 @@ export interface OutputDocker {
   image_name: string;
   publish?: OutputDockerPublish;
   vulnerability_scan?: VulnerabilityScan;
+  args?: DockerBuildArgs;
 }
 export interface DockerReleaseChannel {
   channel: ReleaseChannel;

package/package.json

@@ -7,8 +7,8 @@
   "name": "@schemastore/bxci.schema-2.x",
   "repository": "https://github.com/ffflorian/schemastore-updater/tree/main/schemas/bxci.schema-2.x",
   "scripts": {},
-  "typesPublisherContentHash": "e7434d0458889cb275b3ee86deec6ca85df6c42c2119c9e917b7c97a833d1081",
+  "typeScriptVersion": "2.2",
   "types": "index.d.ts",
-  "version": "0.0.1",
-  "typeScriptVersion": "2.2"
-}
+  "typesPublisherContentHash": "157be268a3c0ceb30a44cc0f5ca9ca020abbcc199c6f423973c5abc5c1733a61",
+  "version": "0.0.2"
+}