From 476c4c52fc9a3d9f71f3e747f496ffed70368f63 Mon Sep 17 00:00:00 2001 From: blam Date: Wed, 9 Feb 2022 13:50:20 +0100 Subject: [PATCH] =?UTF-8?q?chore:=20api-reports=20=F0=9F=98=85?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: blam --- plugins/cicd-statistics/api-report.md | 50 ++++++++++++++++++++++++--- 1 file changed, 45 insertions(+), 5 deletions(-) diff --git a/plugins/cicd-statistics/api-report.md b/plugins/cicd-statistics/api-report.md index c2e7e0934d..3c7a52cdad 100644 --- a/plugins/cicd-statistics/api-report.md +++ b/plugins/cicd-statistics/api-report.md @@ -27,6 +27,7 @@ export interface Build { requestedAt: Date; stages: Array; status: FilterStatusType; + triggeredBy?: TriggerReason; } // Warning: (ae-missing-release-tag) "BuildWithRaw" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) @@ -36,6 +37,16 @@ export type BuildWithRaw = Build & { raw: T; }; +// Warning: (ae-missing-release-tag) "ChartType" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public +export type ChartType = 'duration' | 'count'; + +// Warning: (ae-missing-release-tag) "ChartTypes" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export type ChartTypes = Array; + // Warning: (ae-missing-release-tag) "CicdConfiguration" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public @@ -49,11 +60,13 @@ export interface CicdConfiguration { // // @public export interface CicdDefaults { + chartTypes: Record; collapsedLimit: number; // (undocumented) filterStatus: Array; // (undocumented) filterType: FilterBranchType | 'all'; + hideLimit: number; lowercaseNames: boolean; normalizeTimeRange: boolean; // (undocumented) @@ -162,6 +175,7 @@ export interface Stage { // (undocumented) name: string; stages?: Array; + status: FilterStatusType; } // Warning: (ae-missing-release-tag) "statusTypes" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) @@ -169,14 +183,40 @@ export interface Stage { // @public (undocumented) export const statusTypes: Array; +// Warning: (ae-missing-release-tag) "TriggerReason" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export type TriggerReason = + /** Triggered by source code management, e.g. a Github hook */ + | 'scm' + /** Triggered manually */ + | 'manual' + /** Triggered internally (non-scm, or perhaps after being delayed/enqueued) */ + | 'internal' + /** Triggered for some other reason */ + | 'other'; + +// Warning: (ae-missing-release-tag) "triggerReasons" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export const triggerReasons: Array; + // Warning: (ae-missing-release-tag) "UpdateProgress" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public -export type UpdateProgress = ( - completed: number, - total: number, - started?: number, -) => void; +export interface UpdateProgress { + // (undocumented) + (completed: number, total: number, started?: number): void; + // (undocumented) + ( + steps: Array<{ + title: string; + completed: number; + total: number; + started?: number; + }>, + ): void; +} // (No @packageDocumentation comment for this package) ```