@backstage/plugin-catalog-backend-module-github 0.0.0-nightly-20221018030035 → 0.0.0-nightly-20221021024853

package/CHANGELOG.md

@@ -1,6 +1,37 @@
 # @backstage/plugin-catalog-backend-module-github
 
-## 0.0.0-nightly-20221018030035
+## 0.0.0-nightly-20221021024853
+
+### Minor Changes
+
+- f64d66a45c: Added the ability for the GitHub discovery provider to validate that catalog files exist before emitting them.
+
+  Users can now set the `validateLocationsExist` property to `true` in their GitHub discovery configuration to opt in to this feature.
+  This feature only works with `catalogPath`s that do not contain wildcards.
+
+  When `validateLocationsExist` is set to `true`, the GitHub discovery provider will retrieve the object from the
+  repository at the provided `catalogPath`.
+  If this file exists and is non-empty, then it will be emitted as a location for further processing.
+  If this file does not exist or is empty, then it will not be emitted.
+  Not emitting locations that do not exist allows for far fewer calls to the GitHub API to validate locations that do not exist.
+
+### Patch Changes
+
+- c1784a4980: Replaces in-code uses of `GitHub` with `Github` and deprecates old versions.
+- Updated dependencies
+  - @backstage/backend-common@0.0.0-nightly-20221021024853
+  - @backstage/plugin-catalog-backend@0.0.0-nightly-20221021024853
+  - @backstage/integration@0.0.0-nightly-20221021024853
+  - @backstage/backend-plugin-api@0.0.0-nightly-20221021024853
+  - @backstage/backend-tasks@0.0.0-nightly-20221021024853
+  - @backstage/plugin-catalog-node@0.0.0-nightly-20221021024853
+  - @backstage/catalog-client@0.0.0-nightly-20221021024853
+  - @backstage/catalog-model@0.0.0-nightly-20221021024853
+  - @backstage/config@0.0.0-nightly-20221021024853
+  - @backstage/errors@0.0.0-nightly-20221021024853
+  - @backstage/types@1.0.0
+
+## 0.1.8
 
 ### Patch Changes
 
@@ -9,7 +40,7 @@
   Please find how to configure the schedule at the config at
   https://backstage.io/docs/integrations/github/discovery
 
-- 7022aebf35: Added `GitHubLocationAnalyzer`. This can be used to add to the `CatalogBuilder`. When added this will be used by `RepoLocationAnalyzer` to figure out if the given URL that you are trying to import from the /catalog-import page already contains catalog-info.yaml files.
+- 7022aebf35: Added `GithubLocationAnalyzer`. This can be used to add to the `CatalogBuilder`. When added this will be used by `RepoLocationAnalyzer` to figure out if the given URL that you are trying to import from the /catalog-import page already contains catalog-info.yaml files.
 - 51046b58b0: Use schedule from config at backend module.
 
   Also, it removes `GithubEntityProviderCatalogModuleOptions`
@@ -17,18 +48,33 @@
   like at other similar modules.
 
 - 7edb5909e8: Add missing config schema for the `GitHubEntityProvider`.
+- be9474b103: Replaces in-code uses of `GitHub` by `Github` and deprecates old versions.
+
+  Deprecates
+
+  - `GitHubEntityProvider` replaced by `GithubEntityProvider`
+  - `GitHubLocationAnalyzer` replaced by `GithubLocationAnalyzer`
+  - `GitHubLocationAnalyzerOptions` replaced by `GithubLocationAnalyzerOptions`
+  - `GitHubOrgEntityProvider` replaced by `GithubOrgEntityProvider`
+  - `GitHubOrgEntityProviderOptions` replaced by `GithubOrgEntityProviderOptions`
+
+  Renames
+
+  - `GitHubLocationAnalyzer` to `GithubLocationAnalyzer`
+  - `GitHubLocationAnalyzerOptions` to `GithubLocationAnalyzerOptions`
+
 - a35a27df70: Updated the `moduleId` of the experimental module export.
 - Updated dependencies
-  - @backstage/plugin-catalog-node@0.0.0-nightly-20221018030035
-  - @backstage/catalog-model@0.0.0-nightly-20221018030035
-  - @backstage/backend-common@0.0.0-nightly-20221018030035
-  - @backstage/plugin-catalog-backend@0.0.0-nightly-20221018030035
-  - @backstage/backend-tasks@0.0.0-nightly-20221018030035
-  - @backstage/backend-plugin-api@0.0.0-nightly-20221018030035
-  - @backstage/catalog-client@0.0.0-nightly-20221018030035
-  - @backstage/config@0.0.0-nightly-20221018030035
-  - @backstage/errors@0.0.0-nightly-20221018030035
-  - @backstage/integration@0.0.0-nightly-20221018030035
+  - @backstage/plugin-catalog-node@1.2.0
+  - @backstage/catalog-model@1.1.2
+  - @backstage/backend-common@0.15.2
+  - @backstage/plugin-catalog-backend@1.5.0
+  - @backstage/backend-tasks@0.3.6
+  - @backstage/backend-plugin-api@0.1.3
+  - @backstage/catalog-client@1.1.1
+  - @backstage/config@1.0.3
+  - @backstage/errors@1.1.2
+  - @backstage/integration@1.3.2
   - @backstage/types@1.0.0
 
 ## 0.1.8-next.2

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-backend-module-github",
-  "version": "0.0.0-nightly-20221018030035",
+  "version": "0.0.0-nightly-20221021024853",
   "main": "../dist/index.cjs.js",
   "types": "../dist/index.alpha.d.ts"
 }

package/config.d.ts

@@ -50,7 +50,7 @@ export interface Config {
 
     providers?: {
       /**
-       * GitHubEntityProvider configuration
+       * GithubEntityProvider configuration
        *
        * Uses "default" as default id for the single config variant.
        */

package/dist/index.alpha.d.ts

@@ -13,7 +13,7 @@ import { Entity } from '@backstage/catalog-model';
 import { EntityProvider } from '@backstage/plugin-catalog-backend';
 import { EntityProviderConnection } from '@backstage/plugin-catalog-backend';
 import { GithubCredentialsProvider } from '@backstage/integration';
-import { GitHubIntegrationConfig } from '@backstage/integration';
+import { GithubIntegrationConfig } from '@backstage/integration';
 import { LocationSpec } from '@backstage/plugin-catalog-backend';
 import { Logger } from 'winston';
 import { PluginEndpointDiscovery } from '@backstage/backend-common';
@@ -55,6 +55,23 @@ export declare class GithubDiscoveryProcessor implements CatalogProcessor {
     readLocation(location: LocationSpec, _optional: boolean, emit: CatalogProcessorEmit): Promise<boolean>;
 }
 
+/**
+ * @public
+ * @deprecated Use {@link GithubEntityProvider} instead.
+ */
+export declare class GitHubEntityProvider implements EntityProvider {
+    private readonly delegate;
+    static fromConfig(config: Config, options: {
+        logger: Logger;
+        schedule?: TaskRunner;
+        scheduler?: PluginTaskScheduler;
+    }): GitHubEntityProvider[];
+    private constructor();
+    connect(connection: EntityProviderConnection): Promise<void>;
+    getProviderName(): string;
+    refresh(logger: Logger): Promise<void>;
+}
+
 /**
  * Discovers catalog files located in [GitHub](https://github.com).
  * The provider will search your GitHub account and register catalog files matching the configured path
@@ -63,7 +80,7 @@ export declare class GithubDiscoveryProcessor implements CatalogProcessor {
  *
  * @public
  */
-export declare class GitHubEntityProvider implements EntityProvider {
+export declare class GithubEntityProvider implements EntityProvider {
     private readonly config;
     private readonly logger;
     private readonly integration;
@@ -74,7 +91,7 @@ export declare class GitHubEntityProvider implements EntityProvider {
         logger: Logger;
         schedule?: TaskRunner;
         scheduler?: PluginTaskScheduler;
-    }): GitHubEntityProvider[];
+    }): GithubEntityProvider[];
     private constructor();
     /** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.getProviderName} */
     getProviderName(): string;
@@ -89,17 +106,17 @@ export declare class GitHubEntityProvider implements EntityProvider {
 }
 
 /**
- * Registers the GitHubEntityProvider with the catalog processing extension point.
+ * Registers the {@link GithubEntityProvider} with the catalog processing extension point.
  *
  * @alpha
  */
 export declare const githubEntityProviderCatalogModule: (options?: undefined) => BackendFeature;
 
 /** @public */
-export declare class GitHubLocationAnalyzer implements ScmLocationAnalyzer {
+export declare class GithubLocationAnalyzer implements ScmLocationAnalyzer {
     private readonly catalogClient;
     private readonly config;
-    constructor(options: GitHubLocationAnalyzerOptions);
+    constructor(options: GithubLocationAnalyzerOptions);
     supports(url: string): boolean;
     analyze({ url, catalogFilename }: AnalyzeOptions): Promise<{
         existing: {
@@ -114,7 +131,7 @@ export declare class GitHubLocationAnalyzer implements ScmLocationAnalyzer {
 }
 
 /** @public */
-export declare type GitHubLocationAnalyzerOptions = {
+export declare type GithubLocationAnalyzerOptions = {
     config: Config;
     discovery: PluginEndpointDiscovery;
 };
@@ -165,21 +182,29 @@ export declare class GithubMultiOrgReaderProcessor implements CatalogProcessor {
     private getAllOrgs;
 }
 
+/**
+ * @public
+ * @deprecated Use {@link GithubOrgEntityProvider} instead.
+ */
+export declare class GitHubOrgEntityProvider extends GithubOrgEntityProvider {
+    static fromConfig(config: Config, options: GitHubOrgEntityProviderOptions): GitHubOrgEntityProvider;
+}
+
 /**
  * Ingests org data (users and groups) from GitHub.
  *
  * @public
  */
-export declare class GitHubOrgEntityProvider implements EntityProvider {
+export declare class GithubOrgEntityProvider implements EntityProvider {
     private options;
     private readonly credentialsProvider;
     private connection?;
     private scheduleFn?;
-    static fromConfig(config: Config, options: GitHubOrgEntityProviderOptions): GitHubOrgEntityProvider;
+    static fromConfig(config: Config, options: GithubOrgEntityProviderOptions): GithubOrgEntityProvider;
     constructor(options: {
         id: string;
         orgUrl: string;
-        gitHubConfig: GitHubIntegrationConfig;
+        gitHubConfig: GithubIntegrationConfig;
         logger: Logger;
         githubCredentialsProvider?: GithubCredentialsProvider;
     });
@@ -198,11 +223,17 @@ export declare class GitHubOrgEntityProvider implements EntityProvider {
 }
 
 /**
- * Options for {@link GitHubOrgEntityProvider}.
+ * @public
+ * @deprecated Use {@link GithubOrgEntityProviderOptions} instead.
+ */
+export declare type GitHubOrgEntityProviderOptions = GithubOrgEntityProviderOptions;
+
+/**
+ * Options for {@link GithubOrgEntityProvider}.
  *
  * @public
  */
-export declare interface GitHubOrgEntityProviderOptions {
+export declare interface GithubOrgEntityProviderOptions {
     /**
      * A unique, stable identifier for this provider.
      *
@@ -244,7 +275,7 @@ export declare interface GitHubOrgEntityProviderOptions {
  *
  * @remarks
  *
- * Consider using {@link GitHubOrgEntityProvider} instead.
+ * Consider using {@link GithubOrgEntityProvider} instead.
  *
  * @public
  */

package/dist/index.beta.d.ts

@@ -13,7 +13,7 @@ import { Entity } from '@backstage/catalog-model';
 import { EntityProvider } from '@backstage/plugin-catalog-backend';
 import { EntityProviderConnection } from '@backstage/plugin-catalog-backend';
 import { GithubCredentialsProvider } from '@backstage/integration';
-import { GitHubIntegrationConfig } from '@backstage/integration';
+import { GithubIntegrationConfig } from '@backstage/integration';
 import { LocationSpec } from '@backstage/plugin-catalog-backend';
 import { Logger } from 'winston';
 import { PluginEndpointDiscovery } from '@backstage/backend-common';
@@ -55,6 +55,23 @@ export declare class GithubDiscoveryProcessor implements CatalogProcessor {
     readLocation(location: LocationSpec, _optional: boolean, emit: CatalogProcessorEmit): Promise<boolean>;
 }
 
+/**
+ * @public
+ * @deprecated Use {@link GithubEntityProvider} instead.
+ */
+export declare class GitHubEntityProvider implements EntityProvider {
+    private readonly delegate;
+    static fromConfig(config: Config, options: {
+        logger: Logger;
+        schedule?: TaskRunner;
+        scheduler?: PluginTaskScheduler;
+    }): GitHubEntityProvider[];
+    private constructor();
+    connect(connection: EntityProviderConnection): Promise<void>;
+    getProviderName(): string;
+    refresh(logger: Logger): Promise<void>;
+}
+
 /**
  * Discovers catalog files located in [GitHub](https://github.com).
  * The provider will search your GitHub account and register catalog files matching the configured path
@@ -63,7 +80,7 @@ export declare class GithubDiscoveryProcessor implements CatalogProcessor {
  *
  * @public
  */
-export declare class GitHubEntityProvider implements EntityProvider {
+export declare class GithubEntityProvider implements EntityProvider {
     private readonly config;
     private readonly logger;
     private readonly integration;
@@ -74,7 +91,7 @@ export declare class GitHubEntityProvider implements EntityProvider {
         logger: Logger;
         schedule?: TaskRunner;
         scheduler?: PluginTaskScheduler;
-    }): GitHubEntityProvider[];
+    }): GithubEntityProvider[];
     private constructor();
     /** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.getProviderName} */
     getProviderName(): string;
@@ -91,10 +108,10 @@ export declare class GitHubEntityProvider implements EntityProvider {
 /* Excluded from this release type: githubEntityProviderCatalogModule */
 
 /** @public */
-export declare class GitHubLocationAnalyzer implements ScmLocationAnalyzer {
+export declare class GithubLocationAnalyzer implements ScmLocationAnalyzer {
     private readonly catalogClient;
     private readonly config;
-    constructor(options: GitHubLocationAnalyzerOptions);
+    constructor(options: GithubLocationAnalyzerOptions);
     supports(url: string): boolean;
     analyze({ url, catalogFilename }: AnalyzeOptions): Promise<{
         existing: {
@@ -109,7 +126,7 @@ export declare class GitHubLocationAnalyzer implements ScmLocationAnalyzer {
 }
 
 /** @public */
-export declare type GitHubLocationAnalyzerOptions = {
+export declare type GithubLocationAnalyzerOptions = {
     config: Config;
     discovery: PluginEndpointDiscovery;
 };
@@ -160,21 +177,29 @@ export declare class GithubMultiOrgReaderProcessor implements CatalogProcessor {
     private getAllOrgs;
 }
 
+/**
+ * @public
+ * @deprecated Use {@link GithubOrgEntityProvider} instead.
+ */
+export declare class GitHubOrgEntityProvider extends GithubOrgEntityProvider {
+    static fromConfig(config: Config, options: GitHubOrgEntityProviderOptions): GitHubOrgEntityProvider;
+}
+
 /**
  * Ingests org data (users and groups) from GitHub.
  *
  * @public
  */
-export declare class GitHubOrgEntityProvider implements EntityProvider {
+export declare class GithubOrgEntityProvider implements EntityProvider {
     private options;
     private readonly credentialsProvider;
     private connection?;
     private scheduleFn?;
-    static fromConfig(config: Config, options: GitHubOrgEntityProviderOptions): GitHubOrgEntityProvider;
+    static fromConfig(config: Config, options: GithubOrgEntityProviderOptions): GithubOrgEntityProvider;
     constructor(options: {
         id: string;
         orgUrl: string;
-        gitHubConfig: GitHubIntegrationConfig;
+        gitHubConfig: GithubIntegrationConfig;
         logger: Logger;
         githubCredentialsProvider?: GithubCredentialsProvider;
     });
@@ -193,11 +218,17 @@ export declare class GitHubOrgEntityProvider implements EntityProvider {
 }
 
 /**
- * Options for {@link GitHubOrgEntityProvider}.
+ * @public
+ * @deprecated Use {@link GithubOrgEntityProviderOptions} instead.
+ */
+export declare type GitHubOrgEntityProviderOptions = GithubOrgEntityProviderOptions;
+
+/**
+ * Options for {@link GithubOrgEntityProvider}.
  *
  * @public
  */
-export declare interface GitHubOrgEntityProviderOptions {
+export declare interface GithubOrgEntityProviderOptions {
     /**
      * A unique, stable identifier for this provider.
      *
@@ -239,7 +270,7 @@ export declare interface GitHubOrgEntityProviderOptions {
  *
  * @remarks
  *
- * Consider using {@link GitHubOrgEntityProvider} instead.
+ * Consider using {@link GithubOrgEntityProvider} instead.
  *
  * @public
  */

package/dist/index.cjs.js

@@ -38,7 +38,7 @@ function _interopNamespace(e) {
 var parseGitUrl__default = /*#__PURE__*/_interopDefaultLegacy(parseGitUrl);
 var uuid__namespace = /*#__PURE__*/_interopNamespace(uuid);
 
-class GitHubLocationAnalyzer {
+class GithubLocationAnalyzer {
   constructor(options) {
     this.config = options.config;
     this.catalogClient = new catalogClient.CatalogClient({ discoveryApi: options.discovery });
@@ -244,14 +244,28 @@ async function getOrganizationTeams(client, org, orgNamespace) {
   );
   return { groups, groupMemberUsers };
 }
-async function getOrganizationRepositories(client, org) {
+async function getOrganizationRepositories(client, org, catalogPath) {
+  let relativeCatalogPathRef;
+  if (catalogPath.startsWith("/")) {
+    relativeCatalogPathRef = catalogPath.substring(1);
+  } else {
+    relativeCatalogPathRef = catalogPath;
+  }
+  const catalogPathRef = `HEAD:${relativeCatalogPathRef}`;
   const query = `
-    query repositories($org: String!, $cursor: String) {
+    query repositories($org: String!, $catalogPathRef: String!, $cursor: String) {
       repositoryOwner(login: $org) {
         login
         repositories(first: 100, after: $cursor) {
           nodes {
             name
+            catalogInfoFile: object(expression: $catalogPathRef) {
+              __typename
+              ... on Blob {
+                id
+                text
+              }
+            }
             url
             isArchived
             repositoryTopics(first: 100) {
@@ -282,7 +296,7 @@ async function getOrganizationRepositories(client, org) {
       return (_a = r.repositoryOwner) == null ? void 0 : _a.repositories;
     },
     (x) => x,
-    { org }
+    { org, catalogPathRef }
   );
   return { repositories };
 }
@@ -372,7 +386,7 @@ function assignGroupsToUsers(users, groupMemberUsers) {
   }
 }
 
-function parseGitHubOrgUrl(urlString) {
+function parseGithubOrgUrl(urlString) {
   const path = new URL(urlString).pathname.substr(1).split("/");
   if (path.length === 1 && path[0].length) {
     return { org: decodeURIComponent(path[0]) };
@@ -459,7 +473,11 @@ class GithubDiscoveryProcessor {
     });
     const startTimestamp = Date.now();
     this.logger.info(`Reading GitHub repositories from ${location.target}`);
-    const { repositories } = await getOrganizationRepositories(client, org);
+    const { repositories } = await getOrganizationRepositories(
+      client,
+      org,
+      catalogPath
+    );
     const matching = repositories.filter(
       (r) => !r.isArchived && repoSearchPath.test(r.name)
     );
@@ -641,7 +659,7 @@ class GithubOrgReaderProcessor {
       return false;
     }
     const { client, tokenType } = await this.createClient(location.target);
-    const { org } = parseGitHubOrgUrl(location.target);
+    const { org } = parseGithubOrgUrl(location.target);
     const startTimestamp = Date.now();
     this.logger.info("Reading GitHub users and groups");
     const { users } = await getOrganizationUsers(client, org, tokenType);
@@ -698,7 +716,7 @@ function readProviderConfigs(config) {
   });
 }
 function readProviderConfig(id, config) {
-  var _a, _b;
+  var _a, _b, _c;
   const organization = config.getString("organization");
   const catalogPath = (_a = config.getOptionalString("catalogPath")) != null ? _a : DEFAULT_CATALOG_PATH;
   const host = (_b = config.getOptionalString("host")) != null ? _b : "github.com";
@@ -710,6 +728,13 @@ function readProviderConfig(id, config) {
   const topicFilterExclude = config == null ? void 0 : config.getOptionalStringArray(
     "filters.topic.exclude"
   );
+  const validateLocationsExist = (_c = config == null ? void 0 : config.getOptionalBoolean("validateLocationsExist")) != null ? _c : false;
+  const catalogPathContainsWildcard = catalogPath.includes("*");
+  if (validateLocationsExist && catalogPathContainsWildcard) {
+    throw Error(
+      `Error while processing GitHub provider config. The catalog path ${catalogPath} contains a wildcard, which is incompatible with validation of locations existing before emitting them. Ensure that validateLocationsExist is set to false.`
+    );
+  }
   const schedule = config.has("schedule") ? backendTasks.readTaskScheduleDefinitionFromConfig(config.getConfig("schedule")) : void 0;
   return {
     id,
@@ -724,7 +749,8 @@ function readProviderConfig(id, config) {
         exclude: topicFilterExclude
       }
     },
-    schedule
+    schedule,
+    validateLocationsExist
   };
 }
 function compileRegExp(pattern) {
@@ -738,7 +764,7 @@ function compileRegExp(pattern) {
   return new RegExp(fullLinePattern);
 }
 
-class GitHubEntityProvider {
+class GithubEntityProvider {
   static fromConfig(config, options) {
     if (!options.schedule && !options.scheduler) {
       throw new Error("Either schedule or scheduler must be provided.");
@@ -759,7 +785,7 @@ class GitHubEntityProvider {
         );
       }
       const taskRunner = (_a = options.schedule) != null ? _a : options.scheduler.createScheduledTaskRunner(providerConfig.schedule);
-      return new GitHubEntityProvider(
+      return new GithubEntityProvider(
         providerConfig,
         integration,
         options.logger,
@@ -790,7 +816,7 @@ class GitHubEntityProvider {
         id: taskId,
         fn: async () => {
           const logger = this.logger.child({
-            class: GitHubEntityProvider.prototype.constructor.name,
+            class: GithubEntityProvider.prototype.constructor.name,
             taskId,
             taskInstanceId: uuid__namespace.v4()
           });
@@ -809,7 +835,7 @@ class GitHubEntityProvider {
     }
     const targets = await this.findCatalogFiles();
     const matchingTargets = this.matchesFilters(targets);
-    const entities = matchingTargets.map((repository) => this.createLocationUrl(repository)).map(GitHubEntityProvider.toLocationSpec).map((location) => {
+    const entities = matchingTargets.map((repository) => this.createLocationUrl(repository)).map(GithubEntityProvider.toLocationSpec).map((location) => {
       return {
         locationKey: this.getProviderName(),
         entity: pluginCatalogBackend.locationSpecToLocationEntity({ location })
@@ -826,6 +852,7 @@ class GitHubEntityProvider {
   async findCatalogFiles() {
     const organization = this.config.organization;
     const host = this.integration.host;
+    const catalogPath = this.config.catalogPath;
     const orgUrl = `https://${host}/${organization}`;
     const { headers } = await this.githubCredentialsProvider.getCredentials({
       url: orgUrl
@@ -836,8 +863,15 @@ class GitHubEntityProvider {
     });
     const { repositories } = await getOrganizationRepositories(
       client,
-      organization
+      organization,
+      catalogPath
     );
+    if (this.config.validateLocationsExist) {
+      return repositories.filter((repository) => {
+        var _a;
+        return ((_a = repository.catalogInfoFile) == null ? void 0 : _a.__typename) === "Blob" && repository.catalogInfoFile.text !== "";
+      });
+    }
     return repositories;
   }
   matchesFilters(repositories) {
@@ -868,7 +902,7 @@ class GitHubEntityProvider {
   }
 }
 
-class GitHubOrgEntityProvider {
+class GithubOrgEntityProvider {
   constructor(options) {
     this.options = options;
     this.credentialsProvider = options.githubCredentialsProvider || integration.SingleInstanceGithubCredentialsProvider.create(this.options.gitHubConfig);
@@ -885,7 +919,7 @@ class GitHubOrgEntityProvider {
     const logger = options.logger.child({
       target: options.orgUrl
     });
-    const provider = new GitHubOrgEntityProvider({
+    const provider = new GithubOrgEntityProvider({
       id: options.id,
       orgUrl: options.orgUrl,
       logger,
@@ -896,7 +930,7 @@ class GitHubOrgEntityProvider {
     return provider;
   }
   getProviderName() {
-    return `GitHubOrgEntityProvider:${this.options.id}`;
+    return `GithubOrgEntityProvider:${this.options.id}`;
   }
   async connect(connection) {
     var _a;
@@ -917,7 +951,7 @@ class GitHubOrgEntityProvider {
       baseUrl: this.options.gitHubConfig.apiBaseUrl,
       headers
     });
-    const { org } = parseGitHubOrgUrl(this.options.orgUrl);
+    const { org } = parseGithubOrgUrl(this.options.orgUrl);
     const { users } = await getOrganizationUsers(client, org, tokenType);
     const { groups, groupMemberUsers } = await getOrganizationTeams(
       client,
@@ -949,7 +983,7 @@ class GitHubOrgEntityProvider {
         id,
         fn: async () => {
           const logger = this.options.logger.child({
-            class: GitHubOrgEntityProvider.prototype.constructor.name,
+            class: GithubOrgEntityProvider.prototype.constructor.name,
             taskId: id,
             taskInstanceId: uuid__namespace.v4()
           });
@@ -1008,7 +1042,7 @@ const githubEntityProviderCatalogModule = backendPluginApi.createBackendModule({
       },
       async init({ catalog, config, logger, scheduler }) {
         catalog.addEntityProvider(
-          GitHubEntityProvider.fromConfig(config, {
+          GithubEntityProvider.fromConfig(config, {
             logger: backendPluginApi.loggerToWinstonLogger(logger),
             scheduler
           })
@@ -1018,11 +1052,47 @@ const githubEntityProviderCatalogModule = backendPluginApi.createBackendModule({
   }
 });
 
+class GitHubOrgEntityProvider extends GithubOrgEntityProvider {
+  static fromConfig(config, options) {
+    options.logger.warn(
+      "[Deprecated] Use GithubOrgEntityProvider instead of GitHubOrgEntityProvider."
+    );
+    return GithubOrgEntityProvider.fromConfig(
+      config,
+      options
+    );
+  }
+}
+class GitHubEntityProvider {
+  constructor(delegate) {
+    this.delegate = delegate;
+  }
+  static fromConfig(config, options) {
+    options.logger.warn(
+      "[Deprecated] Please use GithubEntityProvider instead of GitHubEntityProvider."
+    );
+    return GithubEntityProvider.fromConfig(config, options).map(
+      (delegate) => new GitHubEntityProvider(delegate)
+    );
+  }
+  connect(connection) {
+    return this.delegate.connect(connection);
+  }
+  getProviderName() {
+    return this.delegate.getProviderName();
+  }
+  refresh(logger) {
+    return this.delegate.refresh(logger);
+  }
+}
+
 exports.GitHubEntityProvider = GitHubEntityProvider;
-exports.GitHubLocationAnalyzer = GitHubLocationAnalyzer;
 exports.GitHubOrgEntityProvider = GitHubOrgEntityProvider;
 exports.GithubDiscoveryProcessor = GithubDiscoveryProcessor;
+exports.GithubEntityProvider = GithubEntityProvider;
+exports.GithubLocationAnalyzer = GithubLocationAnalyzer;
 exports.GithubMultiOrgReaderProcessor = GithubMultiOrgReaderProcessor;
+exports.GithubOrgEntityProvider = GithubOrgEntityProvider;
 exports.GithubOrgReaderProcessor = GithubOrgReaderProcessor;
 exports.githubEntityProviderCatalogModule = githubEntityProviderCatalogModule;
 //# sourceMappingURL=index.cjs.js.map