@backstage/plugin-catalog-backend-module-github 0.0.0-nightly-20221006024952 → 0.0.0-nightly-20221008024821

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.
Files changed (4) hide show
  1. package/CHANGELOG.md +11 -10
  2. package/alpha/package.json +1 -1
  3. package/config.d.ts +114 -0
  4. package/package.json +12 -12
package/CHANGELOG.md CHANGED
@@ -1,20 +1,21 @@
1
1
  # @backstage/plugin-catalog-backend-module-github
2
2
 
3
- ## 0.0.0-nightly-20221006024952
3
+ ## 0.0.0-nightly-20221008024821
4
4
 
5
5
  ### Patch Changes
6
6
 
7
+ - 7edb5909e8: Add missing config schema for the `GitHubEntityProvider`.
7
8
  - a35a27df70: Updated the `moduleId` of the experimental module export.
8
9
  - Updated dependencies
9
- - @backstage/catalog-model@0.0.0-nightly-20221006024952
10
- - @backstage/backend-tasks@0.0.0-nightly-20221006024952
11
- - @backstage/backend-plugin-api@0.0.0-nightly-20221006024952
12
- - @backstage/backend-common@0.0.0-nightly-20221006024952
13
- - @backstage/plugin-catalog-backend@0.0.0-nightly-20221006024952
14
- - @backstage/plugin-catalog-node@0.0.0-nightly-20221006024952
15
- - @backstage/config@0.0.0-nightly-20221006024952
16
- - @backstage/errors@0.0.0-nightly-20221006024952
17
- - @backstage/integration@0.0.0-nightly-20221006024952
10
+ - @backstage/catalog-model@0.0.0-nightly-20221008024821
11
+ - @backstage/backend-tasks@0.0.0-nightly-20221008024821
12
+ - @backstage/backend-plugin-api@0.0.0-nightly-20221008024821
13
+ - @backstage/backend-common@0.0.0-nightly-20221008024821
14
+ - @backstage/plugin-catalog-backend@0.0.0-nightly-20221008024821
15
+ - @backstage/plugin-catalog-node@0.0.0-nightly-20221008024821
16
+ - @backstage/config@0.0.0-nightly-20221008024821
17
+ - @backstage/errors@0.0.0-nightly-20221008024821
18
+ - @backstage/integration@0.0.0-nightly-20221008024821
18
19
  - @backstage/types@1.0.0
19
20
 
20
21
  ## 0.1.8-next.1
package/alpha/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-catalog-backend-module-github",
3
- "version": "0.0.0-nightly-20221006024952",
3
+ "version": "0.0.0-nightly-20221008024821",
4
4
  "main": "../dist/index.cjs.js",
5
5
  "types": "../dist/index.alpha.d.ts"
6
6
  }
package/config.d.ts CHANGED
@@ -45,5 +45,119 @@ export interface Config {
45
45
  }>;
46
46
  };
47
47
  };
48
+
49
+ providers?: {
50
+ /**
51
+ * GitHubEntityProvider configuration
52
+ *
53
+ * Uses "default" as default id for the single config variant.
54
+ */
55
+ github?:
56
+ | {
57
+ /**
58
+ * (Optional) The hostname of your GitHub Enterprise instance.
59
+ * Default: `github.com`.
60
+ */
61
+ host?: string;
62
+ /**
63
+ * (Required) Name of your organization account/workspace.
64
+ */
65
+ organization: string;
66
+ /**
67
+ * (Optional) Path where to look for `catalog-info.yaml` files.
68
+ * You can use wildcards - `*` or `**` - to search the path and/or the filename
69
+ * Default: `/catalog-info.yaml`.
70
+ */
71
+ catalogPath?: string;
72
+ /**
73
+ * (Optional) Filter configuration.
74
+ */
75
+ filters?: {
76
+ /**
77
+ * (Optional) String used to filter results based on the branch name.
78
+ */
79
+ branch?: string;
80
+ /**
81
+ * (Optional) Regular expression used to filter results based on the repository name.
82
+ */
83
+ repository?: string;
84
+ /**
85
+ * (Optional) GitHub topic-based filters.
86
+ */
87
+ topic?: {
88
+ /**
89
+ * (Optional) An array of strings used to filter in results based on their associated GitHub topics.
90
+ * If configured, only repositories with one (or more) topic(s) present in the inclusion
91
+ * filter will be ingested.
92
+ *
93
+ * If `include` and `exclude` are used, `exclude` has higher priority.
94
+ */
95
+ include?: string[];
96
+ /**
97
+ * (Optional) An array of strings used to filter out results based on their associated GitHub topics.
98
+ * If configured, all repositories _except_ those with one (or more) topics(s) present in
99
+ * the exclusion filter will be ingested.
100
+ *
101
+ * If `include` and `exclude` are used, `exclude` has higher priority.
102
+ */
103
+ exclude?: string[];
104
+ };
105
+ };
106
+ }
107
+ | Record<
108
+ string,
109
+ {
110
+ /**
111
+ * (Optional) The hostname of your GitHub Enterprise instance.
112
+ * Default: `github.com`.
113
+ */
114
+ host?: string;
115
+ /**
116
+ * (Required) Name of your organization account/workspace.
117
+ */
118
+ organization: string;
119
+ /**
120
+ * (Optional) Path where to look for `catalog-info.yaml` files.
121
+ * You can use wildcards - `*` or `**` - to search the path and/or the filename
122
+ * Default: `/catalog-info.yaml`.
123
+ */
124
+ catalogPath?: string;
125
+ /**
126
+ * (Optional) Filter configuration.
127
+ */
128
+ filters?: {
129
+ /**
130
+ * (Optional) String used to filter results based on the branch name.
131
+ */
132
+ branch?: string;
133
+ /**
134
+ * (Optional) Regular expression used to filter results based on the repository name.
135
+ */
136
+ repository?: string;
137
+ /**
138
+ * (Optional) GitHub topic-based filters.
139
+ */
140
+ topic?: {
141
+ /**
142
+ * (Optional) An array of strings used to filter in results based on their associated GitHub topics.
143
+ * If configured, only repositories with one (or more) topic(s) present in the inclusion
144
+ * filter will be ingested.
145
+ *
146
+ * If `include` and `exclude` are used, `exclude` has higher priority.
147
+ */
148
+ include?: string[];
149
+ /**
150
+ * (Optional) An array of strings used to filter out results based on their associated GitHub topics.
151
+ * If configured, all repositories _except_ those with one (or more) topics(s) present in
152
+ * the exclusion filter will be ingested.
153
+ *
154
+ * If `include` and `exclude` are used, `exclude` has higher priority.
155
+ */
156
+ exclude?: string[];
157
+ };
158
+ };
159
+ }
160
+ >;
161
+ };
48
162
  };
49
163
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@backstage/plugin-catalog-backend-module-github",
3
3
  "description": "A Backstage catalog backend module that helps integrate towards GitHub",
4
- "version": "0.0.0-nightly-20221006024952",
4
+ "version": "0.0.0-nightly-20221008024821",
5
5
  "main": "dist/index.cjs.js",
6
6
  "types": "dist/index.d.ts",
7
7
  "license": "Apache-2.0",
@@ -33,15 +33,15 @@
33
33
  "start": "backstage-cli package start"
34
34
  },
35
35
  "dependencies": {
36
- "@backstage/backend-common": "^0.0.0-nightly-20221006024952",
37
- "@backstage/backend-plugin-api": "^0.0.0-nightly-20221006024952",
38
- "@backstage/backend-tasks": "^0.0.0-nightly-20221006024952",
39
- "@backstage/catalog-model": "^0.0.0-nightly-20221006024952",
40
- "@backstage/config": "^0.0.0-nightly-20221006024952",
41
- "@backstage/errors": "^0.0.0-nightly-20221006024952",
42
- "@backstage/integration": "^0.0.0-nightly-20221006024952",
43
- "@backstage/plugin-catalog-backend": "^0.0.0-nightly-20221006024952",
44
- "@backstage/plugin-catalog-node": "^0.0.0-nightly-20221006024952",
36
+ "@backstage/backend-common": "^0.0.0-nightly-20221008024821",
37
+ "@backstage/backend-plugin-api": "^0.0.0-nightly-20221008024821",
38
+ "@backstage/backend-tasks": "^0.0.0-nightly-20221008024821",
39
+ "@backstage/catalog-model": "^0.0.0-nightly-20221008024821",
40
+ "@backstage/config": "^0.0.0-nightly-20221008024821",
41
+ "@backstage/errors": "^0.0.0-nightly-20221008024821",
42
+ "@backstage/integration": "^0.0.0-nightly-20221008024821",
43
+ "@backstage/plugin-catalog-backend": "^0.0.0-nightly-20221008024821",
44
+ "@backstage/plugin-catalog-node": "^0.0.0-nightly-20221008024821",
45
45
  "@backstage/types": "^1.0.0",
46
46
  "@octokit/graphql": "^5.0.0",
47
47
  "lodash": "^4.17.21",
@@ -51,8 +51,8 @@
51
51
  "winston": "^3.2.1"
52
52
  },
53
53
  "devDependencies": {
54
- "@backstage/backend-test-utils": "^0.0.0-nightly-20221006024952",
55
- "@backstage/cli": "^0.0.0-nightly-20221006024952",
54
+ "@backstage/backend-test-utils": "^0.0.0-nightly-20221008024821",
55
+ "@backstage/cli": "^0.0.0-nightly-20221008024821",
56
56
  "@types/lodash": "^4.14.151"
57
57
  },
58
58
  "files": [