@backstage/plugin-catalog-backend-module-github 0.13.0-next.2 → 0.13.0
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 +61 -0
- package/package.json +17 -17
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,66 @@
|
|
|
1
1
|
# @backstage/plugin-catalog-backend-module-github
|
|
2
2
|
|
|
3
|
+
## 0.13.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- b11c2cd: The default user transformer now prefers organization verified domain emails over the user's public GitHub email when populating the user entity profile. It also strips plus-addressed routing tags that GitHub adds to these emails.
|
|
8
|
+
|
|
9
|
+
If you want to retain the old behavior, you can do so with a custom user transformer using the `githubOrgEntityProviderTransformsExtensionPoint`:
|
|
10
|
+
|
|
11
|
+
```ts
|
|
12
|
+
import { createBackendModule } from '@backstage/backend-plugin-api';
|
|
13
|
+
import { githubOrgEntityProviderTransformsExtensionPoint } from '@backstage/plugin-catalog-backend-module-github-org';
|
|
14
|
+
import { defaultUserTransformer } from '@backstage/plugin-catalog-backend-module-github';
|
|
15
|
+
|
|
16
|
+
export default createBackendModule({
|
|
17
|
+
pluginId: 'catalog',
|
|
18
|
+
moduleId: 'github-org-custom-transforms',
|
|
19
|
+
register(env) {
|
|
20
|
+
env.registerInit({
|
|
21
|
+
deps: {
|
|
22
|
+
transforms: githubOrgEntityProviderTransformsExtensionPoint,
|
|
23
|
+
},
|
|
24
|
+
async init({ transforms }) {
|
|
25
|
+
transforms.setUserTransformer(async (item, ctx) => {
|
|
26
|
+
const entity = await defaultUserTransformer(item, ctx);
|
|
27
|
+
if (entity && item.email) {
|
|
28
|
+
entity.spec.profile!.email = item.email;
|
|
29
|
+
}
|
|
30
|
+
return entity;
|
|
31
|
+
});
|
|
32
|
+
},
|
|
33
|
+
});
|
|
34
|
+
},
|
|
35
|
+
});
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### Patch Changes
|
|
39
|
+
|
|
40
|
+
- 6738cf0: build(deps): bump `minimatch` from 9.0.5 to 10.2.1
|
|
41
|
+
- 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.
|
|
42
|
+
|
|
43
|
+
This option has no effect when a custom user transformer is set via the `githubOrgEntityProviderTransformsExtensionPoint`.
|
|
44
|
+
|
|
45
|
+
```yaml
|
|
46
|
+
catalog:
|
|
47
|
+
providers:
|
|
48
|
+
githubOrg:
|
|
49
|
+
production:
|
|
50
|
+
githubUrl: https://github.com
|
|
51
|
+
orgs:
|
|
52
|
+
- my-org
|
|
53
|
+
defaultUserTransformer:
|
|
54
|
+
useVerifiedEmails: true
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
- Updated dependencies
|
|
58
|
+
- @backstage/backend-plugin-api@1.8.0
|
|
59
|
+
- @backstage/integration@2.0.0
|
|
60
|
+
- @backstage/plugin-catalog-node@2.1.0
|
|
61
|
+
- @backstage/catalog-model@1.7.7
|
|
62
|
+
- @backstage/plugin-events-node@0.4.20
|
|
63
|
+
|
|
3
64
|
## 0.13.0-next.2
|
|
4
65
|
|
|
5
66
|
### Patch Changes
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-catalog-backend-module-github",
|
|
3
|
-
"version": "0.13.0
|
|
3
|
+
"version": "0.13.0",
|
|
4
4
|
"description": "A Backstage catalog backend module that helps integrate towards GitHub",
|
|
5
5
|
"backstage": {
|
|
6
6
|
"role": "backend-plugin-module",
|
|
@@ -65,15 +65,15 @@
|
|
|
65
65
|
"test": "backstage-cli package test"
|
|
66
66
|
},
|
|
67
67
|
"dependencies": {
|
|
68
|
-
"@backstage/backend-plugin-api": "1.8.0
|
|
69
|
-
"@backstage/catalog-model": "1.7.
|
|
70
|
-
"@backstage/config": "1.3.6",
|
|
71
|
-
"@backstage/errors": "1.2.7",
|
|
72
|
-
"@backstage/integration": "2.0.0
|
|
73
|
-
"@backstage/plugin-catalog-common": "1.1.8",
|
|
74
|
-
"@backstage/plugin-catalog-node": "2.1.0
|
|
75
|
-
"@backstage/plugin-events-node": "0.4.20
|
|
76
|
-
"@backstage/types": "1.2.2",
|
|
68
|
+
"@backstage/backend-plugin-api": "^1.8.0",
|
|
69
|
+
"@backstage/catalog-model": "^1.7.7",
|
|
70
|
+
"@backstage/config": "^1.3.6",
|
|
71
|
+
"@backstage/errors": "^1.2.7",
|
|
72
|
+
"@backstage/integration": "^2.0.0",
|
|
73
|
+
"@backstage/plugin-catalog-common": "^1.1.8",
|
|
74
|
+
"@backstage/plugin-catalog-node": "^2.1.0",
|
|
75
|
+
"@backstage/plugin-events-node": "^0.4.20",
|
|
76
|
+
"@backstage/types": "^1.2.2",
|
|
77
77
|
"@octokit/auth-callback": "^5.0.0",
|
|
78
78
|
"@octokit/core": "^5.2.0",
|
|
79
79
|
"@octokit/graphql": "^7.0.2",
|
|
@@ -87,13 +87,13 @@
|
|
|
87
87
|
"uuid": "^11.0.0"
|
|
88
88
|
},
|
|
89
89
|
"devDependencies": {
|
|
90
|
-
"@backstage/backend-defaults": "0.16.0
|
|
91
|
-
"@backstage/backend-test-utils": "1.11.1
|
|
92
|
-
"@backstage/cli": "0.36.0
|
|
93
|
-
"@backstage/plugin-catalog-backend": "3.5.0
|
|
94
|
-
"@backstage/plugin-events-backend": "0.6.0
|
|
95
|
-
"@backstage/plugin-events-backend-module-github": "0.4.10
|
|
96
|
-
"@backstage/plugin-events-backend-module-google-pubsub": "0.2.1
|
|
90
|
+
"@backstage/backend-defaults": "^0.16.0",
|
|
91
|
+
"@backstage/backend-test-utils": "^1.11.1",
|
|
92
|
+
"@backstage/cli": "^0.36.0",
|
|
93
|
+
"@backstage/plugin-catalog-backend": "^3.5.0",
|
|
94
|
+
"@backstage/plugin-events-backend": "^0.6.0",
|
|
95
|
+
"@backstage/plugin-events-backend-module-github": "^0.4.10",
|
|
96
|
+
"@backstage/plugin-events-backend-module-google-pubsub": "^0.2.1",
|
|
97
97
|
"@types/lodash": "^4.14.151",
|
|
98
98
|
"msw": "^2.0.0",
|
|
99
99
|
"type-fest": "^4.41.0"
|