chore: moving @alpha types to @public

Signed-off-by: blam <ben@blam.sh>
This commit is contained in:
blam
2023-02-17 11:11:53 +01:00
parent e19c3ab155
commit e3e2c57272
5 changed files with 16 additions and 16 deletions
+7 -7
View File
@@ -6,7 +6,7 @@
import { ApiRef } from '@backstage/core-plugin-api';
import { Entity } from '@backstage/catalog-model';
// @alpha (undocumented)
// @public (undocumented)
export interface FindingSummary {
// (undocumented)
getComponentMeasuresUrl: SonarUrlProcessorFunc;
@@ -25,7 +25,7 @@ export interface FindingSummary {
// @public (undocumented)
export const isSonarQubeAvailable: (entity: Entity) => boolean;
// @alpha (undocumented)
// @public (undocumented)
export type MetricKey =
| 'alert_status'
| 'bugs'
@@ -39,7 +39,7 @@ export type MetricKey =
| 'coverage'
| 'duplicated_lines_density';
// @alpha
// @public
export type Metrics = {
[key in MetricKey]: string | undefined;
};
@@ -47,7 +47,7 @@ export type Metrics = {
// @public (undocumented)
export const SONARQUBE_PROJECT_KEY_ANNOTATION = 'sonarqube.org/project-key';
// @alpha (undocumented)
// @public (undocumented)
export type SonarQubeApi = {
getFindingSummary(options: {
componentKey?: string;
@@ -55,13 +55,13 @@ export type SonarQubeApi = {
}): Promise<FindingSummary | undefined>;
};
// @alpha (undocumented)
// @public (undocumented)
export const sonarQubeApiRef: ApiRef<SonarQubeApi>;
// @alpha (undocumented)
// @public (undocumented)
export type SonarUrlProcessorFunc = (identifier: string) => string;
// @alpha
// @public
export const useProjectInfo: (entity: Entity) => {
projectInstance: string | undefined;
projectKey: string | undefined;
@@ -16,7 +16,7 @@
import { createApiRef } from '@backstage/core-plugin-api';
/** @alpha */
/** @public */
export type MetricKey =
// alert status
| 'alert_status'
@@ -43,11 +43,11 @@ export type MetricKey =
// duplicated lines
| 'duplicated_lines_density';
/** @alpha */
/** @public */
export type SonarUrlProcessorFunc = (identifier: string) => string;
/**
* @alpha
* @public
*
* Define a type to make sure that all metrics are used
*/
@@ -55,7 +55,7 @@ export type Metrics = {
[key in MetricKey]: string | undefined;
};
/** @alpha */
/** @public */
export interface FindingSummary {
lastAnalysis: string;
metrics: Metrics;
@@ -65,12 +65,12 @@ export interface FindingSummary {
getSecurityHotspotsUrl: () => string;
}
/** @alpha */
/** @public */
export const sonarQubeApiRef = createApiRef<SonarQubeApi>({
id: 'plugin.sonarqube.service',
});
/** @alpha */
/** @public */
export type SonarQubeApi = {
getFindingSummary(options: {
componentKey?: string;
@@ -25,7 +25,7 @@ export const SONARQUBE_PROJECT_INSTANCE_SEPARATOR = '/';
*
* If part or all info are not found, they will default to undefined
*
* @alpha
* @public
* @param entity - entity to find the sonarqube information from.
* @returns a ProjectInfo properly populated.
*/