@backstage/plugin-catalog-backend-module-github-org 0.3.20-next.1 → 0.3.20-next.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +26 -0
- package/dist/module.cjs.js +5 -2
- package/dist/module.cjs.js.map +1 -1
- package/package.json +7 -7
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,31 @@
|
|
|
1
1
|
# @backstage/plugin-catalog-backend-module-github-org
|
|
2
2
|
|
|
3
|
+
## 0.3.20-next.2
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 106d1b2: Added a `defaultUserTransformer.useVerifiedEmails` config option for the `githubOrg` provider. When set to `true`, the default user transformer prefers organization verified domain emails over the user's public GitHub email. Defaults to `false`, which uses only the public GitHub email.
|
|
8
|
+
|
|
9
|
+
This option has no effect when a custom user transformer is set via the `githubOrgEntityProviderTransformsExtensionPoint`.
|
|
10
|
+
|
|
11
|
+
```yaml
|
|
12
|
+
catalog:
|
|
13
|
+
providers:
|
|
14
|
+
githubOrg:
|
|
15
|
+
production:
|
|
16
|
+
githubUrl: https://github.com
|
|
17
|
+
orgs:
|
|
18
|
+
- my-org
|
|
19
|
+
defaultUserTransformer:
|
|
20
|
+
useVerifiedEmails: true
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
- Updated dependencies
|
|
24
|
+
- @backstage/backend-plugin-api@1.8.0-next.1
|
|
25
|
+
- @backstage/plugin-catalog-backend-module-github@0.13.0-next.2
|
|
26
|
+
- @backstage/plugin-catalog-node@2.1.0-next.2
|
|
27
|
+
- @backstage/plugin-events-node@0.4.20-next.1
|
|
28
|
+
|
|
3
29
|
## 0.3.20-next.1
|
|
4
30
|
|
|
5
31
|
### Patch Changes
|
package/dist/module.cjs.js
CHANGED
|
@@ -56,7 +56,9 @@ const catalogModuleGithubOrgEntityProvider = backendPluginApi.createBackendModul
|
|
|
56
56
|
definition.schedule
|
|
57
57
|
),
|
|
58
58
|
logger,
|
|
59
|
-
userTransformer
|
|
59
|
+
userTransformer: userTransformer ?? pluginCatalogBackendModuleGithub.buildDefaultUserTransformer({
|
|
60
|
+
useVerifiedEmails: definition.useVerifiedEmails
|
|
61
|
+
}),
|
|
60
62
|
teamTransformer,
|
|
61
63
|
alwaysUseDefaultNamespace: definitions.length === 1 && definition.orgs?.length === 1,
|
|
62
64
|
pageSizes: definition.pageSizes,
|
|
@@ -89,7 +91,8 @@ function readDefinitionsFromConfig(rootConfig) {
|
|
|
89
91
|
"pageSizes.organizationMembers"
|
|
90
92
|
)
|
|
91
93
|
} : void 0,
|
|
92
|
-
excludeSuspendedUsers: c.getOptionalBoolean("excludeSuspendedUsers") ?? false
|
|
94
|
+
excludeSuspendedUsers: c.getOptionalBoolean("excludeSuspendedUsers") ?? false,
|
|
95
|
+
useVerifiedEmails: c.getOptionalBoolean("defaultUserTransformer.useVerifiedEmails") ?? false
|
|
93
96
|
}));
|
|
94
97
|
}
|
|
95
98
|
|
package/dist/module.cjs.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"module.cjs.js","sources":["../src/module.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n coreServices,\n createBackendModule,\n createExtensionPoint,\n SchedulerServiceTaskScheduleDefinition,\n readSchedulerServiceTaskScheduleDefinitionFromConfig,\n} from '@backstage/backend-plugin-api';\nimport { Config } from '@backstage/config';\nimport {\n GithubMultiOrgEntityProvider,\n TeamTransformer,\n UserTransformer,\n} from '@backstage/plugin-catalog-backend-module-github';\nimport { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node';\nimport { eventsServiceRef } from '@backstage/plugin-events-node';\nimport { GithubOrgEntityCleanerProvider } from './GithubOrgEntityCleanerProvider';\n\n/**\n * Interface for {@link githubOrgEntityProviderTransformsExtensionPoint}.\n *\n * @public\n */\nexport interface GithubOrgEntityProviderTransformsExtensionPoint {\n /**\n * Set a custom transformer for transforming from GitHub users to catalog\n * entities.\n */\n setUserTransformer(transformer: UserTransformer): void;\n\n /**\n * Set a custom transformer for transforming from GitHub teams to catalog\n * entities.\n */\n setTeamTransformer(transformer: TeamTransformer): void;\n}\n\n/**\n * Extension point for runtime configuration of catalogModuleGithubOrgEntityProvider.\n *\n * @public\n */\nexport const githubOrgEntityProviderTransformsExtensionPoint =\n createExtensionPoint<GithubOrgEntityProviderTransformsExtensionPoint>({\n id: 'catalog.githubOrgEntityProvider',\n });\n\n/**\n * Registers the `GithubMultiOrgEntityProvider` with the catalog processing extension point.\n *\n * @public\n */\nexport const catalogModuleGithubOrgEntityProvider = createBackendModule({\n pluginId: 'catalog',\n moduleId: 'github-org-entity-provider',\n register(env) {\n let userTransformer: UserTransformer | undefined;\n let teamTransformer: TeamTransformer | undefined;\n\n env.registerExtensionPoint(\n githubOrgEntityProviderTransformsExtensionPoint,\n {\n setUserTransformer(transformer) {\n if (userTransformer) {\n throw new Error('User transformer may only be set once');\n }\n userTransformer = transformer;\n },\n setTeamTransformer(transformer) {\n if (teamTransformer) {\n throw new Error('Team transformer may only be set once');\n }\n teamTransformer = transformer;\n },\n },\n );\n\n env.registerInit({\n deps: {\n catalog: catalogProcessingExtensionPoint,\n config: coreServices.rootConfig,\n events: eventsServiceRef,\n logger: coreServices.logger,\n scheduler: coreServices.scheduler,\n },\n\n async init({ catalog, config, events, logger, scheduler }) {\n const definitions = readDefinitionsFromConfig(config);\n\n for (const definition of definitions) {\n catalog.addEntityProvider(\n new GithubOrgEntityCleanerProvider({ id: definition.id, logger }),\n );\n catalog.addEntityProvider(\n GithubMultiOrgEntityProvider.fromConfig(config, {\n id: definition.id,\n githubUrl: definition.githubUrl,\n orgs: definition.orgs,\n events,\n schedule: scheduler.createScheduledTaskRunner(\n definition.schedule,\n ),\n logger,\n userTransformer,\n teamTransformer,\n alwaysUseDefaultNamespace:\n definitions.length === 1 && definition.orgs?.length === 1,\n pageSizes: definition.pageSizes,\n excludeSuspendedUsers: definition.excludeSuspendedUsers,\n }),\n );\n }\n },\n });\n },\n});\n\nfunction readDefinitionsFromConfig(rootConfig: Config): Array<{\n id: string;\n githubUrl: string;\n orgs?: string[];\n schedule: SchedulerServiceTaskScheduleDefinition;\n pageSizes?: {\n teams?: number;\n teamMembers?: number;\n organizationMembers?: number;\n };\n excludeSuspendedUsers?: boolean;\n}> {\n const baseKey = 'catalog.providers.githubOrg';\n const baseConfig = rootConfig.getOptional(baseKey);\n if (!baseConfig) {\n return [];\n }\n\n const configs = Array.isArray(baseConfig)\n ? rootConfig.getConfigArray(baseKey)\n : [rootConfig.getConfig(baseKey)];\n\n return configs.map(c => ({\n id: c.getString('id'),\n githubUrl: c.getString('githubUrl'),\n orgs: c.getOptionalStringArray('orgs'),\n schedule: readSchedulerServiceTaskScheduleDefinitionFromConfig(\n c.getConfig('schedule'),\n ),\n pageSizes: c.has('pageSizes')\n ? {\n teams: c.getOptionalNumber('pageSizes.teams'),\n teamMembers: c.getOptionalNumber('pageSizes.teamMembers'),\n organizationMembers: c.getOptionalNumber(\n 'pageSizes.organizationMembers',\n ),\n }\n : undefined,\n excludeSuspendedUsers:\n c.getOptionalBoolean('excludeSuspendedUsers') ?? false,\n }));\n}\n"],"names":["createExtensionPoint","createBackendModule","catalogProcessingExtensionPoint","coreServices","eventsServiceRef","GithubOrgEntityCleanerProvider","GithubMultiOrgEntityProvider","readSchedulerServiceTaskScheduleDefinitionFromConfig"],"mappings":";;;;;;;;
|
|
1
|
+
{"version":3,"file":"module.cjs.js","sources":["../src/module.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n coreServices,\n createBackendModule,\n createExtensionPoint,\n SchedulerServiceTaskScheduleDefinition,\n readSchedulerServiceTaskScheduleDefinitionFromConfig,\n} from '@backstage/backend-plugin-api';\nimport { Config } from '@backstage/config';\nimport {\n buildDefaultUserTransformer,\n GithubMultiOrgEntityProvider,\n TeamTransformer,\n UserTransformer,\n} from '@backstage/plugin-catalog-backend-module-github';\nimport { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node';\nimport { eventsServiceRef } from '@backstage/plugin-events-node';\nimport { GithubOrgEntityCleanerProvider } from './GithubOrgEntityCleanerProvider';\n\n/**\n * Interface for {@link githubOrgEntityProviderTransformsExtensionPoint}.\n *\n * @public\n */\nexport interface GithubOrgEntityProviderTransformsExtensionPoint {\n /**\n * Set a custom transformer for transforming from GitHub users to catalog\n * entities.\n */\n setUserTransformer(transformer: UserTransformer): void;\n\n /**\n * Set a custom transformer for transforming from GitHub teams to catalog\n * entities.\n */\n setTeamTransformer(transformer: TeamTransformer): void;\n}\n\n/**\n * Extension point for runtime configuration of catalogModuleGithubOrgEntityProvider.\n *\n * @public\n */\nexport const githubOrgEntityProviderTransformsExtensionPoint =\n createExtensionPoint<GithubOrgEntityProviderTransformsExtensionPoint>({\n id: 'catalog.githubOrgEntityProvider',\n });\n\n/**\n * Registers the `GithubMultiOrgEntityProvider` with the catalog processing extension point.\n *\n * @public\n */\nexport const catalogModuleGithubOrgEntityProvider = createBackendModule({\n pluginId: 'catalog',\n moduleId: 'github-org-entity-provider',\n register(env) {\n let userTransformer: UserTransformer | undefined;\n let teamTransformer: TeamTransformer | undefined;\n\n env.registerExtensionPoint(\n githubOrgEntityProviderTransformsExtensionPoint,\n {\n setUserTransformer(transformer) {\n if (userTransformer) {\n throw new Error('User transformer may only be set once');\n }\n userTransformer = transformer;\n },\n setTeamTransformer(transformer) {\n if (teamTransformer) {\n throw new Error('Team transformer may only be set once');\n }\n teamTransformer = transformer;\n },\n },\n );\n\n env.registerInit({\n deps: {\n catalog: catalogProcessingExtensionPoint,\n config: coreServices.rootConfig,\n events: eventsServiceRef,\n logger: coreServices.logger,\n scheduler: coreServices.scheduler,\n },\n\n async init({ catalog, config, events, logger, scheduler }) {\n const definitions = readDefinitionsFromConfig(config);\n\n for (const definition of definitions) {\n catalog.addEntityProvider(\n new GithubOrgEntityCleanerProvider({ id: definition.id, logger }),\n );\n catalog.addEntityProvider(\n GithubMultiOrgEntityProvider.fromConfig(config, {\n id: definition.id,\n githubUrl: definition.githubUrl,\n orgs: definition.orgs,\n events,\n schedule: scheduler.createScheduledTaskRunner(\n definition.schedule,\n ),\n logger,\n userTransformer:\n userTransformer ??\n buildDefaultUserTransformer({\n useVerifiedEmails: definition.useVerifiedEmails,\n }),\n teamTransformer,\n alwaysUseDefaultNamespace:\n definitions.length === 1 && definition.orgs?.length === 1,\n pageSizes: definition.pageSizes,\n excludeSuspendedUsers: definition.excludeSuspendedUsers,\n }),\n );\n }\n },\n });\n },\n});\n\nfunction readDefinitionsFromConfig(rootConfig: Config): Array<{\n id: string;\n githubUrl: string;\n orgs?: string[];\n schedule: SchedulerServiceTaskScheduleDefinition;\n pageSizes?: {\n teams?: number;\n teamMembers?: number;\n organizationMembers?: number;\n };\n excludeSuspendedUsers?: boolean;\n useVerifiedEmails?: boolean;\n}> {\n const baseKey = 'catalog.providers.githubOrg';\n const baseConfig = rootConfig.getOptional(baseKey);\n if (!baseConfig) {\n return [];\n }\n\n const configs = Array.isArray(baseConfig)\n ? rootConfig.getConfigArray(baseKey)\n : [rootConfig.getConfig(baseKey)];\n\n return configs.map(c => ({\n id: c.getString('id'),\n githubUrl: c.getString('githubUrl'),\n orgs: c.getOptionalStringArray('orgs'),\n schedule: readSchedulerServiceTaskScheduleDefinitionFromConfig(\n c.getConfig('schedule'),\n ),\n pageSizes: c.has('pageSizes')\n ? {\n teams: c.getOptionalNumber('pageSizes.teams'),\n teamMembers: c.getOptionalNumber('pageSizes.teamMembers'),\n organizationMembers: c.getOptionalNumber(\n 'pageSizes.organizationMembers',\n ),\n }\n : undefined,\n excludeSuspendedUsers:\n c.getOptionalBoolean('excludeSuspendedUsers') ?? false,\n useVerifiedEmails:\n c.getOptionalBoolean('defaultUserTransformer.useVerifiedEmails') ?? false,\n }));\n}\n"],"names":["createExtensionPoint","createBackendModule","catalogProcessingExtensionPoint","coreServices","eventsServiceRef","GithubOrgEntityCleanerProvider","GithubMultiOrgEntityProvider","buildDefaultUserTransformer","readSchedulerServiceTaskScheduleDefinitionFromConfig"],"mappings":";;;;;;;;AA0DO,MAAM,kDACXA,qCAAA,CAAsE;AAAA,EACpE,EAAA,EAAI;AACN,CAAC;AAOI,MAAM,uCAAuCC,oCAAA,CAAoB;AAAA,EACtE,QAAA,EAAU,SAAA;AAAA,EACV,QAAA,EAAU,4BAAA;AAAA,EACV,SAAS,GAAA,EAAK;AACZ,IAAA,IAAI,eAAA;AACJ,IAAA,IAAI,eAAA;AAEJ,IAAA,GAAA,CAAI,sBAAA;AAAA,MACF,+CAAA;AAAA,MACA;AAAA,QACE,mBAAmB,WAAA,EAAa;AAC9B,UAAA,IAAI,eAAA,EAAiB;AACnB,YAAA,MAAM,IAAI,MAAM,uCAAuC,CAAA;AAAA,UACzD;AACA,UAAA,eAAA,GAAkB,WAAA;AAAA,QACpB,CAAA;AAAA,QACA,mBAAmB,WAAA,EAAa;AAC9B,UAAA,IAAI,eAAA,EAAiB;AACnB,YAAA,MAAM,IAAI,MAAM,uCAAuC,CAAA;AAAA,UACzD;AACA,UAAA,eAAA,GAAkB,WAAA;AAAA,QACpB;AAAA;AACF,KACF;AAEA,IAAA,GAAA,CAAI,YAAA,CAAa;AAAA,MACf,IAAA,EAAM;AAAA,QACJ,OAAA,EAASC,iDAAA;AAAA,QACT,QAAQC,6BAAA,CAAa,UAAA;AAAA,QACrB,MAAA,EAAQC,iCAAA;AAAA,QACR,QAAQD,6BAAA,CAAa,MAAA;AAAA,QACrB,WAAWA,6BAAA,CAAa;AAAA,OAC1B;AAAA,MAEA,MAAM,KAAK,EAAE,OAAA,EAAS,QAAQ,MAAA,EAAQ,MAAA,EAAQ,WAAU,EAAG;AACzD,QAAA,MAAM,WAAA,GAAc,0BAA0B,MAAM,CAAA;AAEpD,QAAA,KAAA,MAAW,cAAc,WAAA,EAAa;AACpC,UAAA,OAAA,CAAQ,iBAAA;AAAA,YACN,IAAIE,6DAAA,CAA+B,EAAE,IAAI,UAAA,CAAW,EAAA,EAAI,QAAQ;AAAA,WAClE;AACA,UAAA,OAAA,CAAQ,iBAAA;AAAA,YACNC,6DAAA,CAA6B,WAAW,MAAA,EAAQ;AAAA,cAC9C,IAAI,UAAA,CAAW,EAAA;AAAA,cACf,WAAW,UAAA,CAAW,SAAA;AAAA,cACtB,MAAM,UAAA,CAAW,IAAA;AAAA,cACjB,MAAA;AAAA,cACA,UAAU,SAAA,CAAU,yBAAA;AAAA,gBAClB,UAAA,CAAW;AAAA,eACb;AAAA,cACA,MAAA;AAAA,cACA,eAAA,EACE,mBACAC,4DAAA,CAA4B;AAAA,gBAC1B,mBAAmB,UAAA,CAAW;AAAA,eAC/B,CAAA;AAAA,cACH,eAAA;AAAA,cACA,2BACE,WAAA,CAAY,MAAA,KAAW,CAAA,IAAK,UAAA,CAAW,MAAM,MAAA,KAAW,CAAA;AAAA,cAC1D,WAAW,UAAA,CAAW,SAAA;AAAA,cACtB,uBAAuB,UAAA,CAAW;AAAA,aACnC;AAAA,WACH;AAAA,QACF;AAAA,MACF;AAAA,KACD,CAAA;AAAA,EACH;AACF,CAAC;AAED,SAAS,0BAA0B,UAAA,EAYhC;AACD,EAAA,MAAM,OAAA,GAAU,6BAAA;AAChB,EAAA,MAAM,UAAA,GAAa,UAAA,CAAW,WAAA,CAAY,OAAO,CAAA;AACjD,EAAA,IAAI,CAAC,UAAA,EAAY;AACf,IAAA,OAAO,EAAC;AAAA,EACV;AAEA,EAAA,MAAM,OAAA,GAAU,KAAA,CAAM,OAAA,CAAQ,UAAU,CAAA,GACpC,UAAA,CAAW,cAAA,CAAe,OAAO,CAAA,GACjC,CAAC,UAAA,CAAW,SAAA,CAAU,OAAO,CAAC,CAAA;AAElC,EAAA,OAAO,OAAA,CAAQ,IAAI,CAAA,CAAA,MAAM;AAAA,IACvB,EAAA,EAAI,CAAA,CAAE,SAAA,CAAU,IAAI,CAAA;AAAA,IACpB,SAAA,EAAW,CAAA,CAAE,SAAA,CAAU,WAAW,CAAA;AAAA,IAClC,IAAA,EAAM,CAAA,CAAE,sBAAA,CAAuB,MAAM,CAAA;AAAA,IACrC,QAAA,EAAUC,qEAAA;AAAA,MACR,CAAA,CAAE,UAAU,UAAU;AAAA,KACxB;AAAA,IACA,SAAA,EAAW,CAAA,CAAE,GAAA,CAAI,WAAW,CAAA,GACxB;AAAA,MACE,KAAA,EAAO,CAAA,CAAE,iBAAA,CAAkB,iBAAiB,CAAA;AAAA,MAC5C,WAAA,EAAa,CAAA,CAAE,iBAAA,CAAkB,uBAAuB,CAAA;AAAA,MACxD,qBAAqB,CAAA,CAAE,iBAAA;AAAA,QACrB;AAAA;AACF,KACF,GACA,MAAA;AAAA,IACJ,qBAAA,EACE,CAAA,CAAE,kBAAA,CAAmB,uBAAuB,CAAA,IAAK,KAAA;AAAA,IACnD,iBAAA,EACE,CAAA,CAAE,kBAAA,CAAmB,0CAA0C,CAAA,IAAK;AAAA,GACxE,CAAE,CAAA;AACJ;;;;;"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-catalog-backend-module-github-org",
|
|
3
|
-
"version": "0.3.20-next.
|
|
3
|
+
"version": "0.3.20-next.2",
|
|
4
4
|
"description": "The github-org backend module for the catalog plugin.",
|
|
5
5
|
"backstage": {
|
|
6
6
|
"role": "backend-plugin-module",
|
|
@@ -36,15 +36,15 @@
|
|
|
36
36
|
"test": "backstage-cli package test"
|
|
37
37
|
},
|
|
38
38
|
"dependencies": {
|
|
39
|
-
"@backstage/backend-plugin-api": "1.
|
|
39
|
+
"@backstage/backend-plugin-api": "1.8.0-next.1",
|
|
40
40
|
"@backstage/config": "1.3.6",
|
|
41
|
-
"@backstage/plugin-catalog-backend-module-github": "0.13.0-next.
|
|
42
|
-
"@backstage/plugin-catalog-node": "2.1.0-next.
|
|
43
|
-
"@backstage/plugin-events-node": "0.4.20-next.
|
|
41
|
+
"@backstage/plugin-catalog-backend-module-github": "0.13.0-next.2",
|
|
42
|
+
"@backstage/plugin-catalog-node": "2.1.0-next.2",
|
|
43
|
+
"@backstage/plugin-events-node": "0.4.20-next.1"
|
|
44
44
|
},
|
|
45
45
|
"devDependencies": {
|
|
46
|
-
"@backstage/backend-test-utils": "1.11.1-next.
|
|
47
|
-
"@backstage/cli": "0.36.0-next.
|
|
46
|
+
"@backstage/backend-test-utils": "1.11.1-next.2",
|
|
47
|
+
"@backstage/cli": "0.36.0-next.2"
|
|
48
48
|
},
|
|
49
49
|
"typesVersions": {
|
|
50
50
|
"*": {
|