@schemastore/bxci.schema-2.x 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Florian Imdahl. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE

package/README.md

@@ -0,0 +1,12 @@
+# Installation
+> `npm install --save @schemastore/bxci.schema-2.x`
+
+# Summary
+This package contains type definitions for bxci.schema-2.x.
+
+## Details
+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
+* Dependencies: none

package/index.d.ts

@@ -0,0 +1,334 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+/**
+ * Regular expression for validating branch names
+ */
+export type BranchPattern = string;
+/**
+ * Release channel name
+ */
+export type ReleaseChannel = string;
+/**
+ * Indicates on which branches the artifact will be published.
+ */
+export type ReleaseChannelBranch = string;
+/**
+ * Package publish configuration.
+ */
+export type OutputPackagePublish = PackagePublishChannel[];
+/**
+ * Docker publishing information. If not present, no images will be published
+ */
+export type OutputDockerPublish = DockerReleaseChannel[];
+export type OutputHelmUpdatesProperties = {
+  /**
+   * Yaml property (full path) to be updated
+   */
+  key: string;
+  /**
+   * Environment variable whose value will be used to update the property
+   */
+  env?: string;
+  /**
+   * Value to update the given property
+   */
+  value?: string;
+} & OutputHelmUpdatesProperties1;
+export type OutputHelmUpdatesProperties1 =
+  | {
+      [k: string]: unknown;
+    }
+  | {
+      [k: string]: unknown;
+    };
+/**
+ * Helm chart publishing configuration. If not present, no charts will be published
+ */
+export type OutputHelmPublish = HelmReleaseChannel[];
+
+/**
+ * CI configuration for Amdocs Bill Experience projects
+ */
+export interface BxciSchema2 {
+  /**
+   * Project properties
+   */
+  project: {
+    /**
+     * Project's name (used by Jenkins, Docker and Sonar)
+     */
+    name?: string;
+    /**
+     * Project type
+     */
+    type?: "npm" | "maven" | "mvn";
+    /**
+     * ID of a managed maven or npm Jenkins file
+     */
+    settings?: string;
+  };
+  config?: {
+    jenkins_runtime?: {
+      /**
+       * Specifies how to build the Docker container (from an existing image or from a local Dockerfile)
+       */
+      docker: {
+        /**
+         * Prebuilt Docker image (has precedence over dockerfile)
+         */
+        image?: string;
+        /**
+         * Path to a local Dockerfile
+         */
+        dockerfile?: string;
+      };
+    };
+    /**
+     * Describes on which branch names a build will be run
+     */
+    branch?: {
+      branch_pattern?: BranchPattern;
+      /**
+       * Disables branch name validation
+       */
+      disable_validation?: boolean;
+    };
+    build?: {
+      /**
+       * Whether Jenkins workspace should be cleaned after the build
+       */
+      clean_workspace_after_run?: boolean;
+      checkmarx?: Checkmarx;
+      static_analysis?: Sonar;
+    };
+    /**
+     * Cache configuration for projects built inside Docker containers
+     */
+    cache?: {
+      repository: BinaryRepository;
+      /**
+       * List of cache types
+       */
+      items?: CacheItem[];
+    };
+  };
+  /**
+   * Additional services required by the project or application.
+   */
+  services?: ("Postgres" | "Postgis" | "Redis" | "Mssql" | "Mysql" | "Mongodb" | "Elasticsearch")[];
+  /**
+   * Custom environment variables to be added to the pipeline
+   */
+  environment?: {
+    [k: string]: unknown;
+  };
+  /**
+   * 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;
+  };
+  /**
+   * Describes artifacts generated after all the stages have been run
+   */
+  output?: {
+    package?: OutputPackage;
+    docker?: OutputDocker;
+    helm?: OutputHelm;
+  };
+  /**
+   * List of artifacts to archive (wildcards allowed). Check out https://www.jenkins.io/doc/pipeline/steps/core/#archiveartifacts-archive-the-artifacts
+   */
+  archive?: unknown[];
+  /**
+   * Build timeout in seconds
+   */
+  timeout?: number;
+  [k: string]: unknown;
+}
+/**
+ * Adds a Static Analysis stage for CheckMarx. See https://www.jenkins.io/doc/pipeline/steps/checkmarx/ for all the configuration options.
+ */
+export interface Checkmarx {
+  enabled?: boolean;
+  groupId?: string;
+  preset?: string;
+  projectName?: string;
+  /**
+   * Regular expression for validating branch names
+   */
+  branch_pattern?: string;
+  useOwnServerCredentials?: boolean;
+  serverUrl?: string;
+  credentialsId?: string;
+  generatePdfReport?: boolean;
+  sourceEncoding?: string;
+  isProxy?: boolean;
+  waitForResultsEnabled?: boolean;
+}
+/**
+ * Adds a Static Analysis stage for Sonar.
+ */
+export interface Sonar {
+  enabled?: boolean;
+  /**
+   * Waits for analysis result and breaks the build when the project fails for some quality gates.
+   */
+  breaks_build?: boolean;
+  /**
+   * Seconds to wait for the result of the quality gate. Only applies when breaks_build is set to true
+   */
+  timeout?: number;
+}
+/**
+ * Binary repository details
+ */
+export interface BinaryRepository {
+  /**
+   * Repository URL
+   */
+  address: string;
+  /**
+   * Jenkins credentials ID for connecting to this repository
+   */
+  credentials: string;
+}
+export interface CacheItem {
+  /**
+   * Cache type
+   */
+  type: "maven" | "npm";
+  /**
+   * Sets whether this cache type is enabled
+   */
+  enabled: boolean;
+  /**
+   * Location of the cache in the Jenkins workspace
+   */
+  source?: string;
+  /**
+   * Location of the cache directory inside the Docker container
+   */
+  target?: string;
+}
+/**
+ * Stage name in the Jenkins pipeline
+ *
+ * This interface was referenced by `undefined`'s JSON-Schema definition
+ * via the `patternProperty` "^\w+( \w+)*$".
+ */
+export interface Stage {
+  /**
+   * List of steps to run
+   */
+  steps: unknown[];
+  /**
+   * Condition that should be met to run this step
+   */
+  when?: {
+    /**
+     * Specifies in which branches this stage will be executed
+     */
+    branch?: string;
+    [k: string]: unknown;
+  };
+}
+/**
+ * Configuration for publishing NPM or Maven packages
+ */
+export interface OutputPackage {
+  publish: OutputPackagePublish;
+}
+export interface PackagePublishChannel {
+  channel: ReleaseChannel;
+  branch: ReleaseChannelBranch;
+  /**
+   * NPM registry (env variable or registry URL)
+   */
+  registry?: string;
+  /**
+   * Optional params for npm publish or mvn deploy command.
+   */
+  params?: string;
+}
+/**
+ * Configuration for generating a Docker image
+ */
+export interface OutputDocker {
+  /**
+   * Path to Dockerfile used to generate the docker image
+   */
+  dockerfile: string;
+  /**
+   * Image name for the generated docker image. Cannot include tag. Tag will be automatically generated based on project version.
+   */
+  image_name: string;
+  publish?: OutputDockerPublish;
+  vulnerability_scan?: VulnerabilityScan;
+}
+export interface DockerReleaseChannel {
+  channel: ReleaseChannel;
+  branch: ReleaseChannelBranch;
+  /**
+   * Docker registry. Must include protocol (http|https) and port
+   */
+  registry: string;
+  /**
+   * Jenkins credentials ID for publishing into the specified Docker registry
+   */
+  credentials: string;
+}
+/**
+ * Configuration for running vulnerability scans on published Docker images
+ */
+export interface VulnerabilityScan {
+  /**
+   * Whether the vulnerability scan step should be run
+   */
+  enabled?: boolean;
+}
+/**
+ * Configuration for generating a Helm chart
+ */
+export interface OutputHelm {
+  /**
+   * Path to the folder with all required chart config files
+   */
+  path: string;
+  /**
+   * 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
+   */
+  updates: OutputHelmUpdates[];
+  publish: OutputHelmPublish;
+}
+export interface OutputHelmUpdates {
+  /**
+   * Name (including path from Helm object path) of the file to be updated. Only supports yaml files
+   */
+  file: string;
+  /**
+   * A list of properties to update. It can be updated with a fixed value or environment variable
+   */
+  properties: OutputHelmUpdatesProperties[];
+}
+export interface HelmReleaseChannel {
+  channel: ReleaseChannel;
+  branch: ReleaseChannelBranch;
+  /**
+   * Helm chart repository. Must include protocol, host, port (if needed) and path
+   */
+  repository: string;
+  /**
+   * Jenkins credentials Id for this repository for uploading the chart
+   */
+  credentials: string;
+}

package/package.json

@@ -0,0 +1,14 @@
+{
+  "author": "Florian Imdahl <git@ffflorian.de>",
+  "dependencies": {},
+  "description": "TypeScript definitions for bxci.schema-2.x.",
+  "license": "MIT",
+  "main": "index.d.ts",
+  "name": "@schemastore/bxci.schema-2.x",
+  "repository": "https://github.com/ffflorian/schemastore-updater/tree/main/schemas/bxci.schema-2.x",
+  "scripts": {},
+  "typesPublisherContentHash": "e7434d0458889cb275b3ee86deec6ca85df6c42c2119c9e917b7c97a833d1081",
+  "types": "index.d.ts",
+  "version": "0.0.1",
+  "typeScriptVersion": "2.2"
+}