Files
backstage/plugins/sonarqube-backend/config.d.ts
T
Connor Younglund 8e741a1bd2 renamed config and variables
Signed-off-by: Connor Younglund <younglund_connor@bah.com>
2023-08-01 08:42:10 -04:00

71 lines
1.9 KiB
TypeScript

/*
* Copyright 2020 The Backstage Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export interface Config {
/** Optional configurations for the SonarQube plugin */
sonarqube?: {
/**
* The base url of the sonarqube installation. Defaults to https://sonarcloud.io.
* @visibility frontend
*/
baseUrl?: string;
/**
* The external url of the sonarqube installation.
* Use this if you want to use a different url for the frontend than the backend.
* @visibility frontend
*/
externalBaseUrl?: string;
/**
* The api key to access the sonarqube instance under baseUrl.
* @visibility secret
*/
apiKey?: string;
/**
* The optional sonarqube instances.
* @visibility frontend
*/
instances?: Array<{
/**
* The name of the sonarqube instance.
* @visibility frontend
*/
name: string;
/**
* The base url of the sonarqube instance.
* @visibility frontend
*/
baseUrl: string;
/**
* The external url of the sonarqube instance.
* Use this if you want to use a different url for the frontend than the backend.
* @visibility frontend
*/
externalBaseUrl?: string;
/**
* The api key to access the sonarqube instance.
* @visibility secret
*/
apiKey: string;
}>;
};
}