@backstage/plugin-catalog-backend-module-gerrit 0.3.15-next.0 → 0.3.16-next.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.
Files changed (4) hide show
  1. package/CHANGELOG.md +17 -0
  2. package/config.schema.json +205 -0
  3. package/package.json +8 -8
  4. package/config.d.ts +0 -60
package/CHANGELOG.md CHANGED
@@ -1,5 +1,22 @@
1
1
  # @backstage/plugin-catalog-backend-module-gerrit
2
2
 
3
+ ## 0.3.16-next.0
4
+
5
+ ### Patch Changes
6
+
7
+ - Updated dependencies
8
+ - @backstage/backend-plugin-api@1.9.3-next.0
9
+ - @backstage/plugin-catalog-node@2.2.3-next.0
10
+
11
+ ## 0.3.15
12
+
13
+ ### Patch Changes
14
+
15
+ - Updated dependencies
16
+ - @backstage/integration@2.0.3
17
+ - @backstage/backend-plugin-api@1.9.2
18
+ - @backstage/plugin-catalog-node@2.2.2
19
+
3
20
  ## 0.3.15-next.0
4
21
 
5
22
  ### Patch Changes
package/config.schema.json ADDED
@@ -0,0 +1,205 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "catalog": {
6
+ "type": "object",
7
+ "properties": {
8
+ "providers": {
9
+ "type": "object",
10
+ "properties": {
11
+ "gerrit": {
12
+ "type": "object",
13
+ "additionalProperties": {
14
+ "type": "object",
15
+ "properties": {
16
+ "host": {
17
+ "type": "string",
18
+ "description": "(Required) The host of the Gerrit integration to use."
19
+ },
20
+ "query": {
21
+ "type": "string",
22
+ "description": "(Required) The query to use for the \"List Projects\" API call. Used to limit the scope of the projects that the provider tries to ingest."
23
+ },
24
+ "branch": {
25
+ "type": "string",
26
+ "description": "(Optional) Branch. The branch where the provider will try to find entities. Uses the default branch where HEAD points to."
27
+ },
28
+ "catalogPath": {
29
+ "type": "string",
30
+ "description": "(Optional) Path where the catalog YAML manifest file is expected in the repository. Can contain glob patterns supported by minimatch. Defaults to \"catalog-info.yaml\"."
31
+ },
32
+ "schedule": {
33
+ "type": "object",
34
+ "properties": {
35
+ "frequency": {
36
+ "anyOf": [
37
+ {
38
+ "type": "object",
39
+ "properties": {
40
+ "cron": {
41
+ "type": "string",
42
+ "description": "A crontab style string."
43
+ }
44
+ },
45
+ "required": [
46
+ "cron"
47
+ ]
48
+ },
49
+ {
50
+ "type": "object",
51
+ "description": "A Duration object represents a period of time, like \"2 months\" or \"1 day, 1 hour\". Conceptually, it is just a map of units to their quantities, accompanied by some additional configuration and methods for creating, parsing, interrogating, transforming, and formatting them. They can be used on their own or in conjunction with other Luxon types; for example, you can use {@link DateTime.plus } to add a Duration object to a DateTime, producing another DateTime.\n\nHere is a brief overview of commonly used methods and getters in Duration:\n\n* **Creation** To create a Duration, use {@link Duration.fromMillis } , {@link Duration.fromObject } , or {@link Duration.fromISO } .\n* **Unit values** See the {@link Duration#years } , {@link Duration.months } , {@link Duration#weeks } , {@link Duration#days } , {@link Duration#hours } , {@link Duration#minutes } ,\n* {@link Duration#seconds } , {@link Duration#milliseconds } accessors.\n* **Configuration** See {@link Duration#locale } and {@link Duration#numberingSystem } accessors.\n* **Transformation** To create new Durations out of old ones use {@link Duration#plus } , {@link Duration#minus } , {@link Duration#normalize } , {@link Duration#set } , {@link Duration#reconfigure } ,\n* {@link Duration#shiftTo } , and {@link Duration#negate } .\n* **Output** To convert the Duration into other representations, see {@link Duration#as } , {@link Duration#toISO } , {@link Duration#toFormat } , and {@link Duration#toJSON } \n\nThere's are more methods documented below. In addition, for more information on subtler topics like internationalization and validity, see the external documentation."
52
+ },
53
+ {
54
+ "type": "object",
55
+ "properties": {
56
+ "years": {
57
+ "type": "number"
58
+ },
59
+ "months": {
60
+ "type": "number"
61
+ },
62
+ "weeks": {
63
+ "type": "number"
64
+ },
65
+ "days": {
66
+ "type": "number"
67
+ },
68
+ "hours": {
69
+ "type": "number"
70
+ },
71
+ "minutes": {
72
+ "type": "number"
73
+ },
74
+ "seconds": {
75
+ "type": "number"
76
+ },
77
+ "milliseconds": {
78
+ "type": "number"
79
+ }
80
+ },
81
+ "description": "Human friendly durations object."
82
+ },
83
+ {
84
+ "type": "object",
85
+ "properties": {
86
+ "trigger": {
87
+ "type": "string",
88
+ "const": "manual"
89
+ }
90
+ },
91
+ "required": [
92
+ "trigger"
93
+ ]
94
+ }
95
+ ],
96
+ "description": "How often you want the task to run. The system does its best to avoid overlapping invocations."
97
+ },
98
+ "timeout": {
99
+ "anyOf": [
100
+ {
101
+ "type": "object",
102
+ "description": "A Duration object represents a period of time, like \"2 months\" or \"1 day, 1 hour\". Conceptually, it is just a map of units to their quantities, accompanied by some additional configuration and methods for creating, parsing, interrogating, transforming, and formatting them. They can be used on their own or in conjunction with other Luxon types; for example, you can use {@link DateTime.plus } to add a Duration object to a DateTime, producing another DateTime.\n\nHere is a brief overview of commonly used methods and getters in Duration:\n\n* **Creation** To create a Duration, use {@link Duration.fromMillis } , {@link Duration.fromObject } , or {@link Duration.fromISO } .\n* **Unit values** See the {@link Duration#years } , {@link Duration.months } , {@link Duration#weeks } , {@link Duration#days } , {@link Duration#hours } , {@link Duration#minutes } ,\n* {@link Duration#seconds } , {@link Duration#milliseconds } accessors.\n* **Configuration** See {@link Duration#locale } and {@link Duration#numberingSystem } accessors.\n* **Transformation** To create new Durations out of old ones use {@link Duration#plus } , {@link Duration#minus } , {@link Duration#normalize } , {@link Duration#set } , {@link Duration#reconfigure } ,\n* {@link Duration#shiftTo } , and {@link Duration#negate } .\n* **Output** To convert the Duration into other representations, see {@link Duration#as } , {@link Duration#toISO } , {@link Duration#toFormat } , and {@link Duration#toJSON } \n\nThere's are more methods documented below. In addition, for more information on subtler topics like internationalization and validity, see the external documentation."
103
+ },
104
+ {
105
+ "type": "object",
106
+ "properties": {
107
+ "years": {
108
+ "type": "number"
109
+ },
110
+ "months": {
111
+ "type": "number"
112
+ },
113
+ "weeks": {
114
+ "type": "number"
115
+ },
116
+ "days": {
117
+ "type": "number"
118
+ },
119
+ "hours": {
120
+ "type": "number"
121
+ },
122
+ "minutes": {
123
+ "type": "number"
124
+ },
125
+ "seconds": {
126
+ "type": "number"
127
+ },
128
+ "milliseconds": {
129
+ "type": "number"
130
+ }
131
+ },
132
+ "description": "Human friendly durations object."
133
+ }
134
+ ],
135
+ "description": "The maximum amount of time that a single task invocation can take, before it's considered timed out and gets \"released\" such that a new invocation is permitted to take place (possibly, then, on a different worker)."
136
+ },
137
+ "initialDelay": {
138
+ "anyOf": [
139
+ {
140
+ "type": "object",
141
+ "description": "A Duration object represents a period of time, like \"2 months\" or \"1 day, 1 hour\". Conceptually, it is just a map of units to their quantities, accompanied by some additional configuration and methods for creating, parsing, interrogating, transforming, and formatting them. They can be used on their own or in conjunction with other Luxon types; for example, you can use {@link DateTime.plus } to add a Duration object to a DateTime, producing another DateTime.\n\nHere is a brief overview of commonly used methods and getters in Duration:\n\n* **Creation** To create a Duration, use {@link Duration.fromMillis } , {@link Duration.fromObject } , or {@link Duration.fromISO } .\n* **Unit values** See the {@link Duration#years } , {@link Duration.months } , {@link Duration#weeks } , {@link Duration#days } , {@link Duration#hours } , {@link Duration#minutes } ,\n* {@link Duration#seconds } , {@link Duration#milliseconds } accessors.\n* **Configuration** See {@link Duration#locale } and {@link Duration#numberingSystem } accessors.\n* **Transformation** To create new Durations out of old ones use {@link Duration#plus } , {@link Duration#minus } , {@link Duration#normalize } , {@link Duration#set } , {@link Duration#reconfigure } ,\n* {@link Duration#shiftTo } , and {@link Duration#negate } .\n* **Output** To convert the Duration into other representations, see {@link Duration#as } , {@link Duration#toISO } , {@link Duration#toFormat } , and {@link Duration#toJSON } \n\nThere's are more methods documented below. In addition, for more information on subtler topics like internationalization and validity, see the external documentation."
142
+ },
143
+ {
144
+ "type": "object",
145
+ "properties": {
146
+ "years": {
147
+ "type": "number"
148
+ },
149
+ "months": {
150
+ "type": "number"
151
+ },
152
+ "weeks": {
153
+ "type": "number"
154
+ },
155
+ "days": {
156
+ "type": "number"
157
+ },
158
+ "hours": {
159
+ "type": "number"
160
+ },
161
+ "minutes": {
162
+ "type": "number"
163
+ },
164
+ "seconds": {
165
+ "type": "number"
166
+ },
167
+ "milliseconds": {
168
+ "type": "number"
169
+ }
170
+ },
171
+ "description": "Human friendly durations object."
172
+ }
173
+ ],
174
+ "description": "The amount of time that should pass before the first invocation happens."
175
+ },
176
+ "scope": {
177
+ "type": "string",
178
+ "enum": [
179
+ "global",
180
+ "local"
181
+ ],
182
+ "description": "Sets the scope of concurrency control / locking to apply for invocations of this task."
183
+ }
184
+ },
185
+ "required": [
186
+ "frequency",
187
+ "timeout"
188
+ ],
189
+ "description": "(Optional) TaskScheduleDefinition for the discovery."
190
+ }
191
+ },
192
+ "required": [
193
+ "host",
194
+ "query"
195
+ ]
196
+ },
197
+ "description": "GerritEntityProvider configuration\n\nMaps provider id with configuration."
198
+ }
199
+ },
200
+ "description": "List of provider-specific options and attributes"
201
+ }
202
+ }
203
+ }
204
+ }
205
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-catalog-backend-module-gerrit",
3
- "version": "0.3.15-next.0",
3
+ "version": "0.3.16-next.0",
4
4
  "backstage": {
5
5
  "role": "backend-plugin-module",
6
6
  "pluginId": "catalog",
@@ -49,7 +49,7 @@
49
49
  },
50
50
  "files": [
51
51
  "dist",
52
- "config.d.ts"
52
+ "config.schema.json"
53
53
  ],
54
54
  "scripts": {
55
55
  "build": "backstage-cli package build",
@@ -61,20 +61,20 @@
61
61
  "test": "backstage-cli package test"
62
62
  },
63
63
  "dependencies": {
64
- "@backstage/backend-plugin-api": "1.9.2-next.0",
64
+ "@backstage/backend-plugin-api": "1.9.3-next.0",
65
65
  "@backstage/config": "1.3.8",
66
66
  "@backstage/errors": "1.3.1",
67
- "@backstage/integration": "2.0.3-next.0",
67
+ "@backstage/integration": "2.0.3",
68
68
  "@backstage/plugin-catalog-common": "1.1.10",
69
- "@backstage/plugin-catalog-node": "2.2.2-next.0",
69
+ "@backstage/plugin-catalog-node": "2.2.3-next.0",
70
70
  "fs-extra": "^11.2.0",
71
71
  "p-limit": "^3.1.0"
72
72
  },
73
73
  "devDependencies": {
74
- "@backstage/backend-test-utils": "1.11.4-next.0",
75
- "@backstage/cli": "0.36.3-next.0",
74
+ "@backstage/backend-test-utils": "1.11.5-next.0",
75
+ "@backstage/cli": "0.36.4-next.0",
76
76
  "@types/fs-extra": "^11.0.0",
77
77
  "msw": "^1.0.0"
78
78
  },
79
- "configSchema": "config.d.ts"
79
+ "configSchema": "config.schema.json"
80
80
  }
package/config.d.ts DELETED
@@ -1,60 +0,0 @@
1
- /*
2
- * Copyright 2022 The Backstage Authors
3
- *
4
- * Licensed under the Apache License, Version 2.0 (the "License");
5
- * you may not use this file except in compliance with the License.
6
- * You may obtain a copy of the License at
7
- *
8
- * http://www.apache.org/licenses/LICENSE-2.0
9
- *
10
- * Unless required by applicable law or agreed to in writing, software
11
- * distributed under the License is distributed on an "AS IS" BASIS,
12
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
- * See the License for the specific language governing permissions and
14
- * limitations under the License.
15
- */
16
-
17
- import { SchedulerServiceTaskScheduleDefinition } from '@backstage/backend-plugin-api';
18
-
19
- export interface Config {
20
- catalog?: {
21
- /**
22
- * List of provider-specific options and attributes
23
- */
24
- providers?: {
25
- /**
26
- * GerritEntityProvider configuration
27
- *
28
- * Maps provider id with configuration.
29
- */
30
- gerrit?: {
31
- [name: string]: {
32
- /**
33
- * (Required) The host of the Gerrit integration to use.
34
- */
35
- host: string;
36
- /**
37
- * (Required) The query to use for the "List Projects" API call. Used to limit the
38
- * scope of the projects that the provider tries to ingest.
39
- */
40
- query: string;
41
- /**
42
- * (Optional) Branch.
43
- * The branch where the provider will try to find entities. Uses the default branch where HEAD points to.
44
- */
45
- branch?: string;
46
- /**
47
- * (Optional) Path where the catalog YAML manifest file is expected in the repository.
48
- * Can contain glob patterns supported by minimatch.
49
- * Defaults to "catalog-info.yaml".
50
- */
51
- catalogPath?: string;
52
- /**
53
- * (Optional) TaskScheduleDefinition for the discovery.
54
- */
55
- schedule?: SchedulerServiceTaskScheduleDefinition;
56
- };
57
- };
58
- };
59
- };
60
- }