feat: removed baseUrl

BREAKING CHANGE: removed baseUrl and proxyPath
immobiliare · Jan 23, 2023 · 55289a4 · 55289a4
1 parent 7ea418b
commit 55289a4
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -267,7 +267,6 @@ export const apis: AnyApiFactory[] = [
  factory: ({ configApi, discoveryApi }) =>
  CustomGitlabCIClient.setupAPI({
  discoveryApi,
- baseUrl: configApi.getOptionalString('gitlab.baseUrl'),
  codeOwnersPath: configApi.getOptionalString(
  'gitlab.defaultCodeOwnersPath'
  ),

diff --git a/docs/migration-guides.md b/docs/migration-guides.md
@@ -102,3 +102,31 @@ gitlab:
  # Default: ['Component']
  allowedKinds: ['Component', `Resource`]
 ```
+
+6. If you have extended the GitLab API for the support of a new or old GitLab version:
+
+`packages/app/src/api.ts`
+
+```diff
+import { GitlabCIApiRef } from '@immobiliarelabs/backstage-plugin-gitlab';
+import { CustomGitlabCIClient } from '@immobiliarelabs/backstage-plugin-gitlab';
+import { discoveryApiRef, configApiRef } from '@backstage/core-plugin-api';
+import { CustomGitlabCIClient } from 'packages/app/src/myCustomClient.ts';
+
+export const apis: AnyApiFactory[] = [
+ createApiFactory({
+ api: GitlabCIApiRef,
+ deps: { configApi: configApiRef, discoveryApi: discoveryApiRef },
+ factory: ({ configApi, discoveryApi }) =>
+- new CustomGitlabCIClient({
++ CustomGitlabCIClient.setupAPI({
+ discoveryApi,
+- baseUrl: configApi.getOptionalString('gitlab.baseUrl'),
+- proxyPath: configApi.getOptionalString('gitlab.proxyPath'),
+ codeOwnersPath: configApi.getOptionalString(
+ 'gitlab.defaultCodeOwnersPath'
+ ),
+ }),
+ }),
+];
+```
diff --git a/packages/gitlab/src/api/GitlabCIClient.ts b/packages/gitlab/src/api/GitlabCIClient.ts
@@ -19,30 +19,25 @@ import {
 
 export class GitlabCIClient implements GitlabCIApi {
  discoveryApi: DiscoveryApi;
- baseUrl: string;
  codeOwnersPath: string;
  gitlabInstance: string;
 
  constructor({
  discoveryApi,
- baseUrl = 'https://gitlab.com/',
  codeOwnersPath,
  gitlabInstance,
  }: {
  discoveryApi: DiscoveryApi;
- baseUrl?: string;
  codeOwnersPath?: string;
  gitlabInstance: string;
  }) {
  this.discoveryApi = discoveryApi;
- this.baseUrl = baseUrl.endsWith('/') ? baseUrl : `${baseUrl}/`;
  this.codeOwnersPath = codeOwnersPath || 'CODEOWNERS';
  this.gitlabInstance = gitlabInstance;
  }
 
  static setupAPI({
  discoveryApi,
- baseUrl = 'https://gitlab.com/',
  codeOwnersPath,
  }: {
  discoveryApi: DiscoveryApi;
@@ -53,7 +48,6 @@ export class GitlabCIClient implements GitlabCIApi {
  build: (gitlabInstance: string) =>
  new this({
  discoveryApi,
- baseUrl,
  codeOwnersPath,
  gitlabInstance,
  }),

diff --git a/packages/gitlab/src/plugin.ts b/packages/gitlab/src/plugin.ts
@@ -25,7 +25,6 @@ export const gitlabPlugin = createPlugin({
  factory: ({ configApi, discoveryApi }) =>
  GitlabCIClient.setupAPI({
  discoveryApi,
- baseUrl: configApi.getOptionalString('gitlab.baseUrl'),
  codeOwnersPath: configApi.getOptionalString(
  'gitlab.defaultCodeOwnersPath'
  ),