@backstage/plugin-catalog-backend-module-github 0.2.3-next.0 → 0.2.3-next.2

package/CHANGELOG.md

@@ -1,5 +1,53 @@
 # @backstage/plugin-catalog-backend-module-github
 
+## 0.2.3-next.2
+
+### Patch Changes
+
+- f8d91a8810: fixed `catalogPath` option to properly glob match on received GitHub events.
+- 9f2b786fc9: Provide context for logged errors.
+- 8e06f3cf00: Switched imports of `loggerToWinstonLogger` to `@backstage/backend-common`.
+- Updated dependencies
+  - @backstage/backend-plugin-api@0.3.0-next.1
+  - @backstage/backend-common@0.18.0-next.1
+  - @backstage/backend-tasks@0.4.1-next.1
+  - @backstage/catalog-client@1.3.0-next.2
+  - @backstage/plugin-catalog-backend@1.7.0-next.2
+  - @backstage/plugin-catalog-node@1.3.1-next.2
+  - @backstage/plugin-events-node@0.2.1-next.1
+  - @backstage/catalog-model@1.1.5-next.1
+  - @backstage/config@1.0.6-next.0
+  - @backstage/errors@1.1.4
+  - @backstage/integration@1.4.2-next.0
+  - @backstage/types@1.0.2
+  - @backstage/plugin-catalog-common@1.0.10-next.1
+
+## 0.2.3-next.1
+
+### Patch Changes
+
+- 427d8f4411: Added support for event based updates in the `GithubOrgEntityProvider`!
+  Based on webhook events from GitHub the affected `User` or `Group` entity will be refreshed.
+  This includes adding new entities, refreshing existing ones, and removing obsolete ones.
+
+  Please find more information at
+  https://backstage.io/docs/integrations/github/org#installation-with-events-support
+
+- Updated dependencies
+  - @backstage/backend-plugin-api@0.2.1-next.0
+  - @backstage/backend-common@0.18.0-next.0
+  - @backstage/config@1.0.6-next.0
+  - @backstage/plugin-catalog-backend@1.7.0-next.1
+  - @backstage/plugin-catalog-node@1.3.1-next.1
+  - @backstage/plugin-events-node@0.2.1-next.0
+  - @backstage/backend-tasks@0.4.1-next.0
+  - @backstage/catalog-client@1.3.0-next.1
+  - @backstage/catalog-model@1.1.5-next.1
+  - @backstage/errors@1.1.4
+  - @backstage/integration@1.4.2-next.0
+  - @backstage/types@1.0.2
+  - @backstage/plugin-catalog-common@1.0.10-next.1
+
 ## 0.2.3-next.0
 
 ### Patch Changes

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-backend-module-github",
-  "version": "0.2.3-next.0",
+  "version": "0.2.3-next.2",
   "main": "../dist/index.cjs.js",
   "types": "../dist/index.alpha.d.ts"
 }

package/dist/index.alpha.d.ts

@@ -232,7 +232,7 @@ export declare class GitHubOrgEntityProvider extends GithubOrgEntityProvider {
  *
  * @public
  */
-export declare class GithubOrgEntityProvider implements EntityProvider {
+export declare class GithubOrgEntityProvider implements EntityProvider, EventSubscriber {
     private options;
     private readonly credentialsProvider;
     private connection?;
@@ -258,6 +258,14 @@ export declare class GithubOrgEntityProvider implements EntityProvider {
     read(options?: {
         logger?: Logger;
     }): Promise<void>;
+    /** {@inheritdoc @backstage/plugin-events-node#EventSubscriber.onEvent} */
+    onEvent(params: EventParams): Promise<void>;
+    /** {@inheritdoc @backstage/plugin-events-node#EventSubscriber.supportsEventTopics} */
+    supportsEventTopics(): string[];
+    private onTeamEditedInOrganization;
+    private onMembershipChangedInOrganization;
+    private onTeamChangeInOrganization;
+    private onMemberChangeInOrganization;
     private schedule;
 }
 

package/dist/index.beta.d.ts

@@ -227,7 +227,7 @@ export declare class GitHubOrgEntityProvider extends GithubOrgEntityProvider {
  *
  * @public
  */
-export declare class GithubOrgEntityProvider implements EntityProvider {
+export declare class GithubOrgEntityProvider implements EntityProvider, EventSubscriber {
     private options;
     private readonly credentialsProvider;
     private connection?;
@@ -253,6 +253,14 @@ export declare class GithubOrgEntityProvider implements EntityProvider {
     read(options?: {
         logger?: Logger;
     }): Promise<void>;
+    /** {@inheritdoc @backstage/plugin-events-node#EventSubscriber.onEvent} */
+    onEvent(params: EventParams): Promise<void>;
+    /** {@inheritdoc @backstage/plugin-events-node#EventSubscriber.supportsEventTopics} */
+    supportsEventTopics(): string[];
+    private onTeamEditedInOrganization;
+    private onMembershipChangedInOrganization;
+    private onTeamChangeInOrganization;
+    private onMemberChangeInOrganization;
     private schedule;
 }