diff --git a/plugins/cicd-statistics-module-gitlab/README.md b/plugins/cicd-statistics-module-gitlab/README.md index 85c297932e..3cce8b0cde 100644 --- a/plugins/cicd-statistics-module-gitlab/README.md +++ b/plugins/cicd-statistics-module-gitlab/README.md @@ -2,8 +2,4 @@ ## Getting started -Your plugin has been added to the example app in this repository, meaning you'll be able to access it by running `yarn start` in the root directory, and then navigating to [/cicd-statistics-module-gitlab](http://localhost:3000/cicd-statistics-module-gitlab). - -You can also serve the plugin in isolation by running `yarn start` in the plugin directory. -This method of serving the plugin provides quicker iteration speed and a faster startup and hot reloads. -It is only meant for local development, and the setup for it can be found inside the [/dev](./dev) directory. +Will update in another commit diff --git a/plugins/cicd-statistics-module-gitlab/api-report.md b/plugins/cicd-statistics-module-gitlab/api-report.md index c9e1e19016..5e07255f54 100644 --- a/plugins/cicd-statistics-module-gitlab/api-report.md +++ b/plugins/cicd-statistics-module-gitlab/api-report.md @@ -14,8 +14,6 @@ import { OAuthApi } from '@backstage/core-plugin-api'; // @public export class CicdStatisticsApiGitlab implements CicdStatisticsApi { constructor(gitLabAuthApi: OAuthApi); - // Warning: (ae-forgotten-export) The symbol "GitlabClient" needs to be exported by the entry point index.d.ts - // // (undocumented) createGitlabApi(entity: Entity, scopes: string[]): Promise; // (undocumented) @@ -24,5 +22,11 @@ export class CicdStatisticsApiGitlab implements CicdStatisticsApi { getConfiguration(): Promise>; } +// @public +export type GitlabClient = { + api: InstanceType; + owner: string; +}; + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/cicd-statistics-module-gitlab/src/api/gitlab.ts b/plugins/cicd-statistics-module-gitlab/src/api/gitlab.ts index 45b682302b..1c4866557c 100644 --- a/plugins/cicd-statistics-module-gitlab/src/api/gitlab.ts +++ b/plugins/cicd-statistics-module-gitlab/src/api/gitlab.ts @@ -68,8 +68,15 @@ function jobsToStages(jobs: Array): Stage[] { }); } -type GitlabClient = { +/** + * This type represents a initialized gitlab client with gitbeaker + * + * @public + */ +export type GitlabClient = { + /* the actual API of gitbeaker */ api: InstanceType; + /* the owner the repository, retrieved from the entity source location */ owner: string; }; diff --git a/plugins/cicd-statistics-module-gitlab/src/index.ts b/plugins/cicd-statistics-module-gitlab/src/index.ts index 409c45eecd..c8d53d5bd2 100644 --- a/plugins/cicd-statistics-module-gitlab/src/index.ts +++ b/plugins/cicd-statistics-module-gitlab/src/index.ts @@ -15,3 +15,4 @@ */ export { CicdStatisticsApiGitlab } from './api'; +export type { GitlabClient } from './api';