@schemastore/cloud-sdk-pipeline-config-schema 0.0.4 → 0.0.5

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) Florian Keller. All rights reserved.
+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

package/README.md

@@ -8,5 +8,5 @@ This package contains type definitions for cloud-sdk-pipeline-config-schema.
 Files were exported from https://github.com/ffflorian/schemastore-updater/tree/main/schemas/cloud-sdk-pipeline-config-schema.
 
 ## Additional Details
-* Last updated: Sat, Jul 04, 2020, 11:00:04 GMT
+* Last updated: Fri, Feb 24, 2023, 11:23:31 GMT
 * Dependencies: none

package/index.d.ts

@@ -1,42 +1,10 @@
-/* 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,
  * and run json-schema-to-typescript to regenerate this file.
  */
 
-/**
- * Cloud Foundry organization.
- */
-export type Org = string;
-/**
- * Cloud Foundry space.
- */
-export type Space = string;
-/**
- * Name of the application.
- */
-export type AppName = string;
-/**
- * Manifest file that needs to be used.
- */
-export type Manifest = string;
-/**
- * ID to the credentials that will be used.
- */
-export type CredentialsId = string;
-/**
- * URL to the Cloud Foundry endpoint.
- */
-export type ApiEndpoint = string;
-/**
- * (Only for MTA-projects) Path to the mta extension description file. For more information on how to use those extension files please visit the SAP HANA Developer Guide.
- */
-export type MtaExtensionDescriptor = string;
-/**
- * (Only for MTA-projects) Map of credentials that need to be replaced in the mtaExtensionDescriptor. This map needs to be created as value-to-be-replaced:id-of-a-credential-in-jenkins
- */
-export type MtaExtensionCredentials = string;
 /**
  * The image used in the step or stage.
  */
@@ -49,11 +17,11 @@ export type AppUrls = {
   /**
    * ID to the credentials that will be used to connect to the SAP Cloudplatform account.
    */
-  credentialId: string;
+  credentialId?: string;
   /**
-   * Additional parameters can be passed for each end-to-end test deployment by specifying optional parameters for an application URL. These parameters are appended to the npm command during execution.
+   * Additional parameters can be passed for each end-to-end test deployment by specifying optional parameters for an application URL. These parameters are appended to the npm command during execution. These parameters must be a list of strings, where each string corresponds to one element of the parameters. For example, if the parameter `--tag scenario1` should be passed to the test, specify parameters: ['--tag', 'scenario1'].
    */
-  parameters?: string;
+  parameters?: unknown[];
 }[];
 /**
  * Host of the region you want to deploy to, see Regions.
@@ -67,6 +35,10 @@ export type Account = string;
  * Name of the application in your account.
  */
 export type Application = string;
+/**
+ * ID to the credentials that will be used.
+ */
+export type CredentialsId = string;
 /**
  * String of VM arguments passed to the JVM.
  */
@@ -94,6 +66,34 @@ export type NeoTargets = {
   runtime: Runtime;
   runtimeVersion: RuntimeVersion;
 }[];
+/**
+ * Cloud Foundry organization.
+ */
+export type Org = string;
+/**
+ * Cloud Foundry space.
+ */
+export type Space = string;
+/**
+ * Name of the application.
+ */
+export type AppName = string;
+/**
+ * Manifest file that needs to be used.
+ */
+export type Manifest = string;
+/**
+ * URL to the Cloud Foundry endpoint.
+ */
+export type ApiEndpoint = string;
+/**
+ * (Only for MTA-projects) Path to the mta extension description file. For more information on how to use those extension files please visit the SAP HANA Developer Guide.
+ */
+export type MtaExtensionDescriptor = string;
+/**
+ * (Only for MTA-projects) Map of credentials that need to be replaced in the mtaExtensionDescriptor. This map needs to be created as value-to-be-replaced:id-of-a-credential-in-jenkins
+ */
+export type MtaExtensionCredentials = string;
 export type CfTargets = {
   org?: Org;
   space?: Space;
@@ -109,6 +109,10 @@ export type CfTargets = {
  * The configuration file of the SAP Cloud SDK Continuous Delivery Toolkit. For more information please visit https://github.com/SAP/cloud-s4-sdk-pipeline
  */
 export interface SAPCloudSDKPipelineConfigJSONSchema {
+  /**
+   * List of paths or URLs to YAML files with custom defaults to consider. These defaults override built-in defaults, and can be shared across multiple projects. Project configuration takes precedence.
+   */
+  customDefaults?: string[];
   /**
    * The general configuration of the pipeline
    */
@@ -122,21 +126,25 @@ export interface SAPCloudSDKPipelineConfigJSONSchema {
      */
     projectName?: string;
     /**
-     * No personal data is collected. For details, consult the analytics documentation.
+     * Git url of the repository containing the extensions.
      */
-    collectTelemetryData?: boolean;
+    globalExtensionsRepository?: string;
     /**
-     * Enable unsafe mode to skip checking environment variables for insecure elements. Only use this for demo purposes, never for productive usage.
+     * Version of the extensions which should be used, e.g. the tag name
      */
-    unsafeMode?: boolean;
+    globalExtensionsVersion?: string;
+    /**
+     * Credentials required to clone the repository
+     */
+    globalExtensionsRepositoryCredentialsId?: string;
     /**
-     * Apply automated versioning scheme. To disable this feature, set the value to false.
+     * No personal data is collected. For details, consult the analytics documentation.
      */
-    automaticVersioning?: boolean;
+    collectTelemetryData?: boolean;
     /**
-     * Path to a shared configuration file, which is merged with the project's configuration file.
+     * Enable unsafe mode to skip checking environment variables for insecure elements. Only use this for demo purposes, never for productive usage.
      */
-    sharedConfiguration?: string;
+    unsafeMode?: boolean;
     /**
      * Allows enabling or disable certain optional features.
      */
@@ -162,17 +170,6 @@ export interface SAPCloudSDKPipelineConfigJSONSchema {
    * Configuration, which will modify the behaviour of stages in the SAP Cloud SDK Pipeline.
    */
   stages?: {
-    staticCodeChecks?: {
-      /**
-       * A comma-separated list of exclusions (.java source files) expressed as an Ant-style pattern relative to the sources root folder, i.e. application/src/main/java for maven projects and srv/src/main/java for MTA projects.
-       * Example: generated/** /*.java. Please find more details in the maven plugin documentation for pmd.
-       */
-      pmdExcludes?: string;
-      /**
-       * Path to a FindBugs XML exclusion file relative to the application folder.
-       */
-      findbugsExcludesFile?: string;
-    };
     backendIntegrationTests?: {
       /**
        * The number of times that integration tests will retry before aborting the build. Note: This will consume more time for the jenkins build.
@@ -189,11 +186,6 @@ export interface SAPCloudSDKPipelineConfigJSONSchema {
         alias: string;
         credentialId: string;
       }[];
-      /**
-       * Activates the creation of a HDI containers in CAP projects. The name of the container will contain the project name and a random id.
-       */
-      createHdiContainer?: boolean;
-      cloudFoundry?: CloudFoundry;
       /**
        * Name of the Docker image that should be used.
        */
@@ -403,61 +395,13 @@ export interface SAPCloudSDKPipelineConfigJSONSchema {
       };
     };
     /**
-     * Configure Fortify scans.
+     * Configure the stage Compliance, which currently executes a SonarQube (https://www.sonarqube.org/) scan.
      */
-    fortifyScan?: {
-      /**
-       * URL how your Fortify Software Security Center client can be reached.
-       */
-      sscUrl: string;
-      /**
-       * ID of the credentials (username, password) you want to use for the Fortify Software Security Center. Can be configured in executeFortifyScan or here.
-       */
-      fortifyCredentialId: string;
-      /**
-       * Name of your project in Fortify.
-       */
-      fortifyProjectName: string;
-      /**
-       * ID of your project in Fortify.
-       */
-      projectVersionId: string;
-      [k: string]: unknown;
-    };
-    /**
-     * Configure SonarQube (https://www.sonarqube.org/) scans.
-     */
-    sonarQubeScan?: {
+    compliance?: {
       /**
        * Define whether the scan should also happen in non productive branches, i.e. if your SonarQube instance supports that.
        */
       runInAllBranches?: boolean;
-      /**
-       * The project is used to refer your project.
-       */
-      projectKey: string;
-      /**
-       * This property refers to a sonarqube instance, which needs to be defined in the Jenkins.
-       */
-      instance: string;
-      /**
-       * The image used in the step or stage.
-       */
-      dockerImage?: string;
-      [k: string]: unknown;
-    };
-    /**
-     * The lint stage can enforce common coding guidelines within a team.It supports the SAPUI5 best practices linter which operates on SAPUI5 components. A component is identified by a Component.js file in the directory.
-     */
-    lint?: {
-      ui5BestPractices?: {
-        esLanguageLevel?: string;
-        failThreshold?: {
-          error?: number;
-          warning?: number;
-          info?: number;
-        };
-      };
     };
     [k: string]: unknown;
   } | null;
@@ -476,6 +420,33 @@ export interface SAPCloudSDKPipelineConfigJSONSchema {
       projectSettingsFile?: string;
       [k: string]: unknown;
     };
+    /**
+     * If automatic versioning is enabled, this step is used to set a common version for artifacts and optionally push a corresponding tag.
+     */
+    artifactPrepareVersion?: {
+      dockerImage?: DockerImage;
+      /**
+       * Defines the user name which appears in version control for the versioning update (in case versioningType: cloud).
+       */
+      commitUserName?: string;
+      /**
+       * Defines if the automatically generated version (versioningType: cloud) should include the commit id hash.
+       */
+      includeCommitId?: boolean & string;
+      /**
+       * Defines the prefix which is used for the git tag which is written during the versioning run (only versioningType: cloud).
+       */
+      tagPrefix?: string;
+      /**
+       * Defines if the Unix timestamp number should be used as build number instead of the standard date format.
+       */
+      unixTimestamp?: boolean & string;
+      /**
+       * Defines the type of versioning (cloud: fully automatic, cloud_noTag: automatic but no tag created, library: manual)
+       */
+      versioningType?: string;
+      [k: string]: unknown;
+    };
     /**
      * The executeNpm step is used for all invocations of the npm build tool. It is, for example, used for building the frontend and for executing end to end tests.
      */
@@ -488,10 +459,6 @@ export interface SAPCloudSDKPipelineConfigJSONSchema {
        * The default npm registry url to be used as the remote mirror. Bypasses the local download cache if specified.
        */
       defaultNpmRegistry?: string;
-      /**
-       * The default npm registry url to be used as the remote mirror for the SAP npm packages. Bypasses the local download cache if specified.
-       */
-      sapNpmRegistry?: string;
       [k: string]: unknown;
     };
     executeSourceClearScan?: {
@@ -541,16 +508,6 @@ export interface SAPCloudSDKPipelineConfigJSONSchema {
       };
       [k: string]: unknown;
     };
-    /**
-     * SpotBugs static code analysis is executed as part of the static code checks.
-     */
-    checkFindBugs?: {
-      /**
-       * Bug definition filter file.
-       */
-      includeFilterFile?: string;
-      [k: string]: unknown;
-    };
     /**
      * Gatling is used as one of the performance tests tool.
      */
@@ -587,40 +544,77 @@ export interface SAPCloudSDKPipelineConfigJSONSchema {
       unstableThreshold?: number;
       [k: string]: unknown;
     };
-    executeFortifyScan?: {
-      dockerImage: DockerImage;
+    fortifyExecuteScan?: {
+      dockerImage?: DockerImage;
       /**
-       * Sends the verbose out put to the Jenkins log.
+       * Sends the verbose output to the Jenkins log.
        */
       verbose?: boolean;
       /**
-       * Java version of the source code that needs to be scanned
+       * Jenkins 'Secret text' credentials ID containing token to authenticate to Fortify SSC.
+       */
+      fortifyCredentialsId: string;
+      /**
+       * Jenkins 'Secret text' credentials ID containing token to authenticate to GitHub.
        */
-      sourceVersion?: string;
+      githubTokenCredentialsId?: string;
       /**
-       * The build ID for the Fortify scan.
+       * Fortify SSC Url to be used for accessing the APIs
        */
-      buildId?: string;
+      serverUrl?: string;
       /**
-       * Runs Fortify SCA inside the 64-bit JRE.
+       * The project used for reporting results in SSC
        */
-      use64BitVersion?: string;
+      projectName?: string;
       /**
-       * Maximum heap size of the JVM which runs Fortify SCA.
+       * The default project versioning model used in case 'projectVersion' parameter is empty for creating the version based on the build descriptor version to report results in SSC, can be one of 'major', 'major-minor', 'semantic', 'full'
        */
-      maximumMemoryUsage?: string;
+      defaultVersioningModel?: string;
       /**
-       * File and directories that needs to excluded from the scanning.
+       * Scan type used for the step which can be 'maven', 'pip'
        */
-      exclude?: string;
+      buildTool?: string;
       /**
-       * Skip the node modules from the scanning.
+       * Whether Fortify project and project version shall be implicitly auto created in case they cannot be found in the backend
        */
-      skipNgComponents?: string;
+      autoCreate?: boolean;
       /**
-       * Additional Fortify options such as thread count, alias usage etc.
+       * Whether results shall be uploaded or not
        */
-      additionalScanOptions?: string;
+      uploadResults?: boolean;
+      /**
+       * The amount of memory granted to the translate/scan executions
+       */
+      memory?: string;
+      /**
+       * A list of source directories to scan. Wildcards can be used, e.g., 'src/main/java/** /*'. The default value for buildTool: 'maven' is ['** /*.xml', '** /*.html', '** /*.jsp', '** /*.js', '** /src/main/resources/** /*', '** /src/main/java/** /*'], for buildTool: 'pip' it is ['./** /*'].
+       */
+      src?: string[];
+      /**
+       * A list of directories/files to be excluded from the scan. Wildcards can be used, e.g., '** /Test.java'.
+       */
+      exclude?: string[];
+      [k: string]: unknown;
+    };
+    /**
+     * Configure credentials for WhiteSource scans. The minimum required Maven WhiteSource plugin version is 18.6.2, ensure this in the plugins section of the project pom.xml file.
+     *
+     * Pipeline will execute npx whitesource run for npm projects. Please ensure that all package.json files have a name configured so that it is possible to distinguish between the different packages.
+     */
+    whitesourceExecuteScan?: {
+      /**
+       * Name of your product in WhiteSource.
+       */
+      productName: string;
+      /**
+       * Overwrites the project version in the WhiteSource UI per scan with the given version. Per default, the version from the main build descriptor file is used and transformed according to the versioningModel parameter, i.e. "1" for the default model of "major".
+       */
+      productVersion?: string;
+      orgAdminUserTokenCredentialsId: CredentialsId;
+      /**
+       * Unique identifier of the Secret Text on Jenkins server that stores WhiteSource userKey of a user. This is required only if the administrator of the WhiteSource service has enabled additional access level control. More details can be found here.
+       */
+      userTokenCredentialsId?: string;
       [k: string]: unknown;
     };
     mtaBuild?: {
@@ -666,7 +660,32 @@ export interface SAPCloudSDKPipelineConfigJSONSchema {
       mtaJarLocation?: string;
       [k: string]: unknown;
     };
-    createHdiContainer?: {
+    /**
+     * The debugReportArchive configuration can be used to create confidential (instead of redacted) debug reports. The difference between the redacted and the confidential debug report is that potentially confidential information, such as the GitHub repository and branch, global extension repository and shared libraries, are included in the confidential debug report. It is the user's responsibility to make sure that the debug report does not contain any confidential information.
+     */
+    debugReportArchive?: {
+      /**
+       * If set to true, a confidential debug report is being generated with each build.
+       */
+      shareConfidentialInformation?: boolean;
+      [k: string]: unknown;
+    };
+    /**
+     * Configure SonarQube (https://www.sonarqube.org/) scans.
+     */
+    sonarExecuteScan?: {
+      /**
+       * The project key is used to refer your project.
+       */
+      projectKey: string;
+      /**
+       * This property refers to a SonarQube instance, which needs to be defined in the Jenkins.
+       */
+      instance: string;
+      /**
+       * A list of additional options (in the form of '-Dxy=z') to be passed to the sonar scanner tool.
+       */
+      options?: unknown[] | string;
       /**
        * The image used in the step or stage.
        */
@@ -674,19 +693,33 @@ export interface SAPCloudSDKPipelineConfigJSONSchema {
       [k: string]: unknown;
     };
     /**
-     * The debugReportArchive configuration can be used to create confidential (instead of redacted) debug reports. The difference between the redacted and the confidential debug report is that potentially confidential information, such as the GitHub repository and branch, global extension repository and shared libraries, are included in the confidential debug report. It is the user's responsibility to make sure that the debug report does not contain any confidential information.
+     * This step allows you to upload an MTA file (multi-target application archive) and multiple MTA extension descriptors into a TMS (SAP Cloud Platform Transport Management Service) landscape for further TMS-controlled distribution through a TMS-configured landscape.
      */
-    debugReportArchive?: {
+    tmsUpload?: {
       /**
-       * If set to true, a confidential debug report is being generated with each build.
+       * Defines the name of the node to which the *.mtar file should be uploaded.
        */
-      shareConfidentialInformation?: boolean;
+      nodeName?: string;
+      /**
+       * Credentials to be used for the file and node uploads to the Transport Management Service.
+       */
+      credentialsId?: string;
+      /**
+       * Can be used as the description of a transport request. Will overwrite the default.
+       */
+      customDescription?: string;
       [k: string]: unknown;
     };
     [k: string]: unknown;
   } | null;
   [k: string]: unknown;
 }
+/**
+ * Map of environment variables in the form of KEY: VALUE.
+ */
+export interface Environment {
+  [k: string]: unknown;
+}
 /**
  * A map specifying the Cloud Foundry specific parameters.
  */
@@ -700,9 +733,3 @@ export interface CloudFoundry {
   mtaExtensionDescriptor?: MtaExtensionDescriptor;
   mtaExtensionCredentials?: MtaExtensionCredentials;
 }
-/**
- * Map of environment variables in the form of KEY: VALUE.
- */
-export interface Environment {
-  [k: string]: unknown;
-}

package/package.json

@@ -1,5 +1,5 @@
 {
-  "author": "Florian Keller <github@floriankeller.de>",
+  "author": "Florian Imdahl <git@ffflorian.de>",
   "dependencies": {},
   "description": "TypeScript definitions for cloud-sdk-pipeline-config-schema.",
   "license": "MIT",
@@ -7,8 +7,8 @@
   "name": "@schemastore/cloud-sdk-pipeline-config-schema",
   "repository": "https://github.com/ffflorian/schemastore-updater/tree/main/schemas/cloud-sdk-pipeline-config-schema",
   "scripts": {},
-  "typesPublisherContentHash": "67fed8630f52350ccf65b840640bfa5b8d5fd07e62c1adbc4b1abf29a7ef2b55",
+  "typesPublisherContentHash": "e83903166740812f2e6ea6c5cc280afd7900c92d79b87ec40bf4f31686694f00",
   "types": "index.d.ts",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "typeScriptVersion": "2.2"
 }