repository-provider 26.4.5 → 26.6.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/README.md +119 -132
- package/package.json +3 -3
- package/src/attribute.mjs +9 -2
- package/src/base-object.mjs +2 -2
- package/src/base-provider.mjs +14 -7
package/README.md
CHANGED
|
@@ -92,39 +92,38 @@ console.log(await readme.getString());
|
|
|
92
92
|
* [MessageDestination](#messagedestination)
|
|
93
93
|
* [Parameters](#parameters-13)
|
|
94
94
|
* [BaseProvider](#baseprovider)
|
|
95
|
-
* [Parameters](#parameters-14)
|
|
96
95
|
* [Properties](#properties-1)
|
|
97
96
|
* [equals](#equals-1)
|
|
98
|
-
* [Parameters](#parameters-
|
|
97
|
+
* [Parameters](#parameters-14)
|
|
99
98
|
* [repositoryBases](#repositorybases)
|
|
100
99
|
* [normalizeRepositoryName](#normalizerepositoryname)
|
|
101
|
-
* [Parameters](#parameters-
|
|
100
|
+
* [Parameters](#parameters-15)
|
|
102
101
|
* [normalizeGroupName](#normalizegroupname)
|
|
103
|
-
* [Parameters](#parameters-
|
|
102
|
+
* [Parameters](#parameters-16)
|
|
104
103
|
* [areRepositoryNamesCaseSensitive](#arerepositorynamescasesensitive)
|
|
105
104
|
* [areGroupNamesCaseSensitive](#aregroupnamescasesensitive)
|
|
106
105
|
* [supportsBase](#supportsbase)
|
|
107
|
-
* [Parameters](#parameters-
|
|
106
|
+
* [Parameters](#parameters-17)
|
|
108
107
|
* [parseName](#parsename)
|
|
109
|
-
* [Parameters](#parameters-
|
|
108
|
+
* [Parameters](#parameters-18)
|
|
110
109
|
* [createRepository](#createrepository)
|
|
111
|
-
* [Parameters](#parameters-
|
|
110
|
+
* [Parameters](#parameters-19)
|
|
112
111
|
* [list](#list)
|
|
113
|
-
* [Parameters](#parameters-
|
|
112
|
+
* [Parameters](#parameters-20)
|
|
114
113
|
* [projects](#projects)
|
|
115
|
-
* [Parameters](#parameters-
|
|
114
|
+
* [Parameters](#parameters-21)
|
|
116
115
|
* [milestones](#milestones)
|
|
117
|
-
* [Parameters](#parameters-
|
|
116
|
+
* [Parameters](#parameters-22)
|
|
118
117
|
* [repositories](#repositories)
|
|
119
|
-
* [Parameters](#parameters-
|
|
118
|
+
* [Parameters](#parameters-23)
|
|
120
119
|
* [branches](#branches)
|
|
121
|
-
* [Parameters](#parameters-
|
|
120
|
+
* [Parameters](#parameters-24)
|
|
122
121
|
* [tags](#tags)
|
|
123
|
-
* [Parameters](#parameters-
|
|
122
|
+
* [Parameters](#parameters-25)
|
|
124
123
|
* [hooks](#hooks)
|
|
125
|
-
* [Parameters](#parameters-
|
|
124
|
+
* [Parameters](#parameters-26)
|
|
126
125
|
* [pullRequests](#pullrequests)
|
|
127
|
-
* [Parameters](#parameters-
|
|
126
|
+
* [Parameters](#parameters-27)
|
|
128
127
|
* [name](#name)
|
|
129
128
|
* [provider](#provider-1)
|
|
130
129
|
* [url](#url)
|
|
@@ -138,83 +137,81 @@ console.log(await readme.getString());
|
|
|
138
137
|
* [pullRequestClass](#pullrequestclass-1)
|
|
139
138
|
* [instanceIdentifier](#instanceidentifier)
|
|
140
139
|
* [optionsFromEnvironment](#optionsfromenvironment)
|
|
141
|
-
* [Parameters](#parameters-
|
|
140
|
+
* [Parameters](#parameters-28)
|
|
142
141
|
* [areOptionsSufficcient](#areoptionssufficcient)
|
|
143
|
-
* [Parameters](#parameters-
|
|
142
|
+
* [Parameters](#parameters-29)
|
|
144
143
|
* [initialize](#initialize)
|
|
145
|
-
* [Parameters](#parameters-
|
|
144
|
+
* [Parameters](#parameters-30)
|
|
146
145
|
* [priority](#priority)
|
|
147
146
|
* [name](#name-1)
|
|
148
147
|
* [messageDestination](#messagedestination-1)
|
|
149
|
-
* [Commit](#commit)
|
|
150
|
-
* [Properties](#properties-2)
|
|
151
|
-
* [Commit](#commit-1)
|
|
152
|
-
* [Parameters](#parameters-32)
|
|
153
|
-
* [Properties](#properties-3)
|
|
154
|
-
* [CommitResult](#commitresult)
|
|
155
|
-
* [Properties](#properties-4)
|
|
156
148
|
* [Branch](#branch)
|
|
157
|
-
* [Parameters](#parameters-
|
|
158
|
-
* [Properties](#properties-
|
|
149
|
+
* [Parameters](#parameters-31)
|
|
150
|
+
* [Properties](#properties-2)
|
|
159
151
|
* [url](#url-1)
|
|
160
152
|
* [refType](#reftype)
|
|
161
153
|
* [isDefault](#isdefault)
|
|
162
154
|
* [delete](#delete)
|
|
163
|
-
* [commit](#commit
|
|
164
|
-
* [Parameters](#parameters-
|
|
155
|
+
* [commit](#commit)
|
|
156
|
+
* [Parameters](#parameters-32)
|
|
165
157
|
* [commitIntoPullRequest](#commitintopullrequest)
|
|
166
|
-
* [Parameters](#parameters-
|
|
158
|
+
* [Parameters](#parameters-33)
|
|
167
159
|
* [removeEntries](#removeentries)
|
|
168
|
-
* [Parameters](#parameters-
|
|
160
|
+
* [Parameters](#parameters-34)
|
|
169
161
|
* [createPullRequest](#createpullrequest)
|
|
170
|
-
* [Parameters](#parameters-
|
|
162
|
+
* [Parameters](#parameters-35)
|
|
171
163
|
* [createBranch](#createbranch)
|
|
172
|
-
* [Parameters](#parameters-
|
|
164
|
+
* [Parameters](#parameters-36)
|
|
165
|
+
* [CommitResult](#commitresult)
|
|
166
|
+
* [Properties](#properties-3)
|
|
167
|
+
* [Commit](#commit-1)
|
|
168
|
+
* [Parameters](#parameters-37)
|
|
169
|
+
* [Properties](#properties-4)
|
|
173
170
|
* [Hook](#hook)
|
|
174
|
-
* [Parameters](#parameters-
|
|
175
|
-
* [Properties](#properties-
|
|
171
|
+
* [Parameters](#parameters-38)
|
|
172
|
+
* [Properties](#properties-5)
|
|
176
173
|
* [equals](#equals-2)
|
|
177
|
-
* [Parameters](#parameters-
|
|
174
|
+
* [Parameters](#parameters-39)
|
|
178
175
|
* [toJSON](#tojson-1)
|
|
179
176
|
* [Issue](#issue)
|
|
180
|
-
* [Parameters](#parameters-
|
|
177
|
+
* [Parameters](#parameters-40)
|
|
181
178
|
* [Milestone](#milestone)
|
|
182
|
-
* [Parameters](#parameters-
|
|
179
|
+
* [Parameters](#parameters-41)
|
|
183
180
|
* [MultiGroupProvider](#multigroupprovider)
|
|
184
|
-
* [Parameters](#parameters-
|
|
181
|
+
* [Parameters](#parameters-42)
|
|
185
182
|
* [repository](#repository)
|
|
186
|
-
* [Parameters](#parameters-
|
|
183
|
+
* [Parameters](#parameters-43)
|
|
187
184
|
* [branch](#branch-1)
|
|
188
|
-
* [Parameters](#parameters-
|
|
185
|
+
* [Parameters](#parameters-44)
|
|
189
186
|
* [repositoryGroup](#repositorygroup)
|
|
190
|
-
* [Parameters](#parameters-
|
|
187
|
+
* [Parameters](#parameters-45)
|
|
191
188
|
* [repositoryGroups](#repositorygroups)
|
|
192
|
-
* [Parameters](#parameters-
|
|
189
|
+
* [Parameters](#parameters-46)
|
|
193
190
|
* [createRepositoryGroup](#createrepositorygroup)
|
|
194
|
-
* [Parameters](#parameters-
|
|
191
|
+
* [Parameters](#parameters-47)
|
|
195
192
|
* [addRepositoryGroup](#addrepositorygroup)
|
|
196
|
-
* [Parameters](#parameters-
|
|
193
|
+
* [Parameters](#parameters-48)
|
|
197
194
|
* [NamedObject](#namedobject)
|
|
198
|
-
* [Parameters](#parameters-
|
|
199
|
-
* [Properties](#properties-
|
|
195
|
+
* [Parameters](#parameters-49)
|
|
196
|
+
* [Properties](#properties-6)
|
|
200
197
|
* [equals](#equals-3)
|
|
201
|
-
* [Parameters](#parameters-
|
|
198
|
+
* [Parameters](#parameters-50)
|
|
202
199
|
* [displayName](#displayname)
|
|
203
200
|
* [toJSON](#tojson-2)
|
|
204
201
|
* [Project](#project)
|
|
205
|
-
* [Parameters](#parameters-
|
|
202
|
+
* [Parameters](#parameters-51)
|
|
206
203
|
* [PullRequest](#pullrequest)
|
|
207
|
-
* [Parameters](#parameters-
|
|
208
|
-
* [Properties](#properties-
|
|
204
|
+
* [Parameters](#parameters-52)
|
|
205
|
+
* [Properties](#properties-7)
|
|
209
206
|
* [fullName](#fullname)
|
|
210
207
|
* [url](#url-2)
|
|
211
208
|
* [repository](#repository-1)
|
|
212
209
|
* [provider](#provider-2)
|
|
213
210
|
* [equals](#equals-4)
|
|
214
|
-
* [Parameters](#parameters-
|
|
211
|
+
* [Parameters](#parameters-53)
|
|
215
212
|
* [delete](#delete-1)
|
|
216
213
|
* [merge](#merge)
|
|
217
|
-
* [Parameters](#parameters-
|
|
214
|
+
* [Parameters](#parameters-54)
|
|
218
215
|
* [decline](#decline)
|
|
219
216
|
* [reviews](#reviews)
|
|
220
217
|
* [identifier](#identifier)
|
|
@@ -222,9 +219,9 @@ console.log(await readme.getString());
|
|
|
222
219
|
* [defaultListStates](#defaultliststates)
|
|
223
220
|
* [validMergeMethods](#validmergemethods)
|
|
224
221
|
* [list](#list-1)
|
|
225
|
-
* [Parameters](#parameters-
|
|
222
|
+
* [Parameters](#parameters-55)
|
|
226
223
|
* [open](#open)
|
|
227
|
-
* [Parameters](#parameters-
|
|
224
|
+
* [Parameters](#parameters-56)
|
|
228
225
|
* [title](#title)
|
|
229
226
|
* [body](#body)
|
|
230
227
|
* [state](#state)
|
|
@@ -232,21 +229,21 @@ console.log(await readme.getString());
|
|
|
232
229
|
* [merged](#merged)
|
|
233
230
|
* [draft](#draft)
|
|
234
231
|
* [ContentEntry](#contententry)
|
|
235
|
-
* [Properties](#properties-
|
|
232
|
+
* [Properties](#properties-8)
|
|
236
233
|
* [Ref](#ref)
|
|
237
|
-
* [Parameters](#parameters-
|
|
234
|
+
* [Parameters](#parameters-57)
|
|
238
235
|
* [equals](#equals-5)
|
|
239
|
-
* [Parameters](#parameters-
|
|
236
|
+
* [Parameters](#parameters-58)
|
|
240
237
|
* [ref](#ref-1)
|
|
241
238
|
* [refId](#refid)
|
|
242
|
-
* [Parameters](#parameters-
|
|
239
|
+
* [Parameters](#parameters-59)
|
|
243
240
|
* [entries](#entries)
|
|
244
|
-
* [Parameters](#parameters-
|
|
241
|
+
* [Parameters](#parameters-60)
|
|
245
242
|
* [asyncIterator](#asynciterator)
|
|
246
243
|
* [maybeEntry](#maybeentry)
|
|
247
|
-
* [Parameters](#parameters-
|
|
244
|
+
* [Parameters](#parameters-61)
|
|
248
245
|
* [entry](#entry)
|
|
249
|
-
* [Parameters](#parameters-
|
|
246
|
+
* [Parameters](#parameters-62)
|
|
250
247
|
* [owner](#owner)
|
|
251
248
|
* [fullName](#fullname-1)
|
|
252
249
|
* [fullCondensedName](#fullcondensedname)
|
|
@@ -261,28 +258,28 @@ console.log(await readme.getString());
|
|
|
261
258
|
* [attributes](#attributes-1)
|
|
262
259
|
* [isProtected](#isprotected-1)
|
|
263
260
|
* [RepositoryGroup](#repositorygroup-1)
|
|
264
|
-
* [Parameters](#parameters-
|
|
265
|
-
* [Properties](#properties-
|
|
261
|
+
* [Parameters](#parameters-63)
|
|
262
|
+
* [Properties](#properties-9)
|
|
266
263
|
* [attributeMapping](#attributemapping-1)
|
|
267
264
|
* [type](#type)
|
|
268
265
|
* [url](#url-3)
|
|
269
266
|
* [RepositoryOwner](#repositoryowner)
|
|
270
|
-
* [Parameters](#parameters-
|
|
267
|
+
* [Parameters](#parameters-64)
|
|
271
268
|
* [Repository](#repository-2)
|
|
272
|
-
* [Parameters](#parameters-
|
|
273
|
-
* [Properties](#properties-
|
|
269
|
+
* [Parameters](#parameters-65)
|
|
270
|
+
* [Properties](#properties-10)
|
|
274
271
|
* [fullName](#fullname-2)
|
|
275
272
|
* [slug](#slug)
|
|
276
273
|
* [provider](#provider-3)
|
|
277
274
|
* [identifier](#identifier-2)
|
|
278
275
|
* [equals](#equals-6)
|
|
279
|
-
* [Parameters](#parameters-
|
|
276
|
+
* [Parameters](#parameters-66)
|
|
280
277
|
* [entry](#entry-1)
|
|
281
|
-
* [Parameters](#parameters-
|
|
278
|
+
* [Parameters](#parameters-67)
|
|
282
279
|
* [entries](#entries-1)
|
|
283
|
-
* [Parameters](#parameters-
|
|
280
|
+
* [Parameters](#parameters-68)
|
|
284
281
|
* [maybeEntry](#maybeentry-1)
|
|
285
|
-
* [Parameters](#parameters-
|
|
282
|
+
* [Parameters](#parameters-69)
|
|
286
283
|
* [urls](#urls)
|
|
287
284
|
* [url](#url-4)
|
|
288
285
|
* [cloneURL](#cloneurl)
|
|
@@ -295,41 +292,41 @@ console.log(await readme.getString());
|
|
|
295
292
|
* [isTemplate](#istemplate)
|
|
296
293
|
* [defaultBranch](#defaultbranch)
|
|
297
294
|
* [branch](#branch-2)
|
|
298
|
-
* [Parameters](#parameters-
|
|
295
|
+
* [Parameters](#parameters-70)
|
|
299
296
|
* [branches](#branches-1)
|
|
300
|
-
* [Parameters](#parameters-
|
|
297
|
+
* [Parameters](#parameters-71)
|
|
301
298
|
* [createBranch](#createbranch-1)
|
|
302
|
-
* [Parameters](#parameters-
|
|
299
|
+
* [Parameters](#parameters-72)
|
|
303
300
|
* [addBranch](#addbranch)
|
|
304
|
-
* [Parameters](#parameters-
|
|
301
|
+
* [Parameters](#parameters-73)
|
|
305
302
|
* [deleteBranch](#deletebranch)
|
|
306
|
-
* [Parameters](#parameters-
|
|
303
|
+
* [Parameters](#parameters-74)
|
|
307
304
|
* [tag](#tag)
|
|
308
|
-
* [Parameters](#parameters-
|
|
305
|
+
* [Parameters](#parameters-75)
|
|
309
306
|
* [tags](#tags-1)
|
|
310
|
-
* [Parameters](#parameters-
|
|
307
|
+
* [Parameters](#parameters-76)
|
|
311
308
|
* [addTag](#addtag)
|
|
312
|
-
* [Parameters](#parameters-
|
|
309
|
+
* [Parameters](#parameters-77)
|
|
313
310
|
* [delete](#delete-2)
|
|
314
311
|
* [createPullRequest](#createpullrequest-1)
|
|
315
|
-
* [Parameters](#parameters-
|
|
312
|
+
* [Parameters](#parameters-78)
|
|
316
313
|
* [addPullRequest](#addpullrequest)
|
|
317
|
-
* [Parameters](#parameters-
|
|
314
|
+
* [Parameters](#parameters-79)
|
|
318
315
|
* [pullRequests](#pullrequests-1)
|
|
319
316
|
* [pullRequest](#pullrequest-1)
|
|
320
|
-
* [Parameters](#parameters-
|
|
317
|
+
* [Parameters](#parameters-80)
|
|
321
318
|
* [deletePullRequest](#deletepullrequest)
|
|
322
|
-
* [Parameters](#parameters-
|
|
319
|
+
* [Parameters](#parameters-81)
|
|
323
320
|
* [addHook](#addhook)
|
|
324
|
-
* [Parameters](#parameters-
|
|
321
|
+
* [Parameters](#parameters-82)
|
|
325
322
|
* [createHook](#createhook)
|
|
326
|
-
* [Parameters](#parameters-
|
|
323
|
+
* [Parameters](#parameters-83)
|
|
327
324
|
* [hooks](#hooks-1)
|
|
328
325
|
* [hook](#hook-1)
|
|
329
|
-
* [Parameters](#parameters-
|
|
326
|
+
* [Parameters](#parameters-84)
|
|
330
327
|
* [type](#type-1)
|
|
331
328
|
* [refId](#refid-1)
|
|
332
|
-
* [Parameters](#parameters-
|
|
329
|
+
* [Parameters](#parameters-85)
|
|
333
330
|
* [toJSON](#tojson-3)
|
|
334
331
|
* [attributes](#attributes-2)
|
|
335
332
|
* [defaultBranchName](#defaultbranchname)
|
|
@@ -338,23 +335,23 @@ console.log(await readme.getString());
|
|
|
338
335
|
* [Review](#review)
|
|
339
336
|
* [SingleGroupProvider](#singlegroupprovider)
|
|
340
337
|
* [repository](#repository-3)
|
|
341
|
-
* [Parameters](#parameters-
|
|
338
|
+
* [Parameters](#parameters-86)
|
|
342
339
|
* [repositoryGroup](#repositorygroup-2)
|
|
343
|
-
* [Parameters](#parameters-
|
|
340
|
+
* [Parameters](#parameters-87)
|
|
344
341
|
* [repositoryGroups](#repositorygroups-1)
|
|
345
|
-
* [Parameters](#parameters-
|
|
342
|
+
* [Parameters](#parameters-88)
|
|
346
343
|
* [Tag](#tag-1)
|
|
347
|
-
* [Parameters](#parameters-
|
|
344
|
+
* [Parameters](#parameters-89)
|
|
348
345
|
* [refType](#reftype-1)
|
|
349
346
|
* [isWritable](#iswritable-1)
|
|
350
347
|
* [asArray](#asarray)
|
|
351
|
-
* [Parameters](#parameters-
|
|
348
|
+
* [Parameters](#parameters-90)
|
|
352
349
|
* [stripBaseName](#stripbasename)
|
|
353
|
-
* [Parameters](#parameters-
|
|
350
|
+
* [Parameters](#parameters-91)
|
|
354
351
|
* [stripBaseNames](#stripbasenames)
|
|
355
|
-
* [Parameters](#parameters-
|
|
352
|
+
* [Parameters](#parameters-92)
|
|
356
353
|
* [generateBranchName](#generatebranchname)
|
|
357
|
-
* [Parameters](#parameters-
|
|
354
|
+
* [Parameters](#parameters-93)
|
|
358
355
|
|
|
359
356
|
## Application
|
|
360
357
|
|
|
@@ -374,8 +371,10 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
|
|
|
374
371
|
|
|
375
372
|
* `type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
|
|
376
373
|
* `writable` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**
|
|
377
|
-
* `private` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
|
|
374
|
+
* `private` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** should the value be shown
|
|
378
375
|
* `description` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
|
|
376
|
+
* `default` **any?** the default value
|
|
377
|
+
* `env` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>)?** environment variable use to provide the value
|
|
379
378
|
|
|
380
379
|
## definePropertiesFromOptions
|
|
381
380
|
|
|
@@ -485,8 +484,8 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
|
|
|
485
484
|
|
|
486
485
|
### Parameters
|
|
487
486
|
|
|
488
|
-
* `options` **
|
|
489
|
-
* `additionalProperties` **
|
|
487
|
+
* `options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
|
|
488
|
+
* `additionalProperties` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
|
|
490
489
|
|
|
491
490
|
### update
|
|
492
491
|
|
|
@@ -624,10 +623,7 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
|
|
|
624
623
|
|
|
625
624
|
## BaseProvider
|
|
626
625
|
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
* `options`
|
|
630
|
-
* `properties`
|
|
626
|
+
**Extends BaseObject**
|
|
631
627
|
|
|
632
628
|
### Properties
|
|
633
629
|
|
|
@@ -905,35 +901,6 @@ Name of the provider
|
|
|
905
901
|
|
|
906
902
|
to forward info/warn and error messages to
|
|
907
903
|
|
|
908
|
-
## Commit
|
|
909
|
-
|
|
910
|
-
Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
|
|
911
|
-
|
|
912
|
-
### Properties
|
|
913
|
-
|
|
914
|
-
* `message` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
|
|
915
|
-
* `updates` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[ContentEntry](#contententry)>**
|
|
916
|
-
|
|
917
|
-
## Commit
|
|
918
|
-
|
|
919
|
-
### Parameters
|
|
920
|
-
|
|
921
|
-
* `repository`
|
|
922
|
-
|
|
923
|
-
### Properties
|
|
924
|
-
|
|
925
|
-
* `repository` **[Repository](#repository)**
|
|
926
|
-
* `message` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
|
|
927
|
-
* `sha` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
|
|
928
|
-
|
|
929
|
-
## CommitResult
|
|
930
|
-
|
|
931
|
-
Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
|
|
932
|
-
|
|
933
|
-
### Properties
|
|
934
|
-
|
|
935
|
-
* `ref` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
|
|
936
|
-
|
|
937
904
|
## Branch
|
|
938
905
|
|
|
939
906
|
**Extends Ref**
|
|
@@ -1038,6 +1005,26 @@ Simply calls Repository.createBranch() with the receiver as source branch
|
|
|
1038
1005
|
|
|
1039
1006
|
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Branch](#branch)>** newly created branch (or already present old one with the same name)
|
|
1040
1007
|
|
|
1008
|
+
## CommitResult
|
|
1009
|
+
|
|
1010
|
+
Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
|
|
1011
|
+
|
|
1012
|
+
### Properties
|
|
1013
|
+
|
|
1014
|
+
* `ref` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
|
|
1015
|
+
|
|
1016
|
+
## Commit
|
|
1017
|
+
|
|
1018
|
+
### Parameters
|
|
1019
|
+
|
|
1020
|
+
* `repository`
|
|
1021
|
+
|
|
1022
|
+
### Properties
|
|
1023
|
+
|
|
1024
|
+
* `repository` **[Repository](#repository)**
|
|
1025
|
+
* `message` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
|
|
1026
|
+
* `sha` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
|
|
1027
|
+
|
|
1041
1028
|
## Hook
|
|
1042
1029
|
|
|
1043
1030
|
**Extends BaseObject**
|
|
@@ -1436,7 +1423,7 @@ List entries of the branch.
|
|
|
1436
1423
|
|
|
1437
1424
|
#### Parameters
|
|
1438
1425
|
|
|
1439
|
-
* `matchingPatterns` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
1426
|
+
* `matchingPatterns` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>?**
|
|
1440
1427
|
|
|
1441
1428
|
Returns **AsyncIterator<[ContentEntry](#contententry)>** all matching entries in the branch
|
|
1442
1429
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "repository-provider",
|
|
3
|
-
"version": "26.
|
|
3
|
+
"version": "26.6.2",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"access": "public"
|
|
6
6
|
},
|
|
@@ -36,9 +36,9 @@
|
|
|
36
36
|
"ava": "^4.0.1",
|
|
37
37
|
"c8": "^7.11.0",
|
|
38
38
|
"documentation": "^13.2.5",
|
|
39
|
-
"repository-provider-test-support": "^1.
|
|
39
|
+
"repository-provider-test-support": "^1.12.1",
|
|
40
40
|
"semantic-release": "^19.0.2",
|
|
41
|
-
"typescript": "^4.6.0-dev.
|
|
41
|
+
"typescript": "^4.6.0-dev.20220207"
|
|
42
42
|
},
|
|
43
43
|
"engines": {
|
|
44
44
|
"node": ">=14.18.3"
|
package/src/attribute.mjs
CHANGED
|
@@ -3,8 +3,10 @@
|
|
|
3
3
|
*
|
|
4
4
|
* @property {string} type
|
|
5
5
|
* @property {boolean} writable
|
|
6
|
-
* @property {boolean} private
|
|
6
|
+
* @property {boolean} [private] should the value be shown
|
|
7
7
|
* @property {string} description
|
|
8
|
+
* @property {any} [default] the default value
|
|
9
|
+
* @property {string|string[]} [env] environment variable use to provide the value
|
|
8
10
|
*/
|
|
9
11
|
|
|
10
12
|
/**
|
|
@@ -43,7 +45,8 @@ export function definePropertiesFromOptions(
|
|
|
43
45
|
const first = path.shift();
|
|
44
46
|
const property = properties[first];
|
|
45
47
|
|
|
46
|
-
let value = options
|
|
48
|
+
let value = getAttribute(options, name);
|
|
49
|
+
|
|
47
50
|
if (value === undefined) {
|
|
48
51
|
if (attribute.getDefault) {
|
|
49
52
|
value = attribute.getDefault(attribute, object);
|
|
@@ -152,6 +155,10 @@ export function setAttribute(object, name, value) {
|
|
|
152
155
|
export function getAttribute(object, name) {
|
|
153
156
|
let value = object;
|
|
154
157
|
|
|
158
|
+
if(value && value[name] !== undefined) {
|
|
159
|
+
return value[name];
|
|
160
|
+
}
|
|
161
|
+
|
|
155
162
|
for (const p of name.split(/\./)) {
|
|
156
163
|
if (value === undefined) {
|
|
157
164
|
break;
|
package/src/base-object.mjs
CHANGED
|
@@ -65,8 +65,8 @@ export class BaseObject {
|
|
|
65
65
|
|
|
66
66
|
/**
|
|
67
67
|
* Creates an instance of BaseObject.
|
|
68
|
-
* @param {
|
|
69
|
-
* @param {
|
|
68
|
+
* @param {object} options
|
|
69
|
+
* @param {object} additionalProperties
|
|
70
70
|
*/
|
|
71
71
|
constructor(options, additionalProperties) {
|
|
72
72
|
definePropertiesFromOptions(
|
package/src/base-provider.mjs
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
import { asArray, stripBaseName } from "./util.mjs";
|
|
2
|
-
import { definePropertiesFromOptions } from "./attribute.mjs";
|
|
3
2
|
import { PullRequest } from "./pull-request.mjs";
|
|
4
3
|
import { RepositoryGroup } from "./repository-group.mjs";
|
|
5
4
|
import { Repository } from "./repository.mjs";
|
|
@@ -8,6 +7,7 @@ import { Tag } from "./tag.mjs";
|
|
|
8
7
|
import { Hook } from "./hook.mjs";
|
|
9
8
|
import { Project } from "./project.mjs";
|
|
10
9
|
import { Milestone } from "./milestone.mjs";
|
|
10
|
+
import { BaseObject } from "./base-object.mjs";
|
|
11
11
|
|
|
12
12
|
/**
|
|
13
13
|
* @typedef {Object} MessageDestination
|
|
@@ -20,7 +20,7 @@ import { Milestone } from "./milestone.mjs";
|
|
|
20
20
|
/**
|
|
21
21
|
* @property {MessageDestination} messageDestination
|
|
22
22
|
*/
|
|
23
|
-
export class BaseProvider {
|
|
23
|
+
export class BaseProvider extends BaseObject {
|
|
24
24
|
/**
|
|
25
25
|
* @return {string} identifier for environment options
|
|
26
26
|
*/
|
|
@@ -87,6 +87,7 @@ export class BaseProvider {
|
|
|
87
87
|
|
|
88
88
|
static get attributes() {
|
|
89
89
|
return {
|
|
90
|
+
...super.attributes,
|
|
90
91
|
/**
|
|
91
92
|
* In case there are several provider able to support a given source which one sould be used ?
|
|
92
93
|
* this defines the order
|
|
@@ -100,10 +101,12 @@ export class BaseProvider {
|
|
|
100
101
|
* Name of the provider
|
|
101
102
|
*/
|
|
102
103
|
name: {
|
|
103
|
-
type: "string"
|
|
104
|
+
type: "string",
|
|
105
|
+
env: ["{{instanceIdentifier}}NAME"]
|
|
104
106
|
},
|
|
105
107
|
|
|
106
108
|
url: {
|
|
109
|
+
description: "home of the provider",
|
|
107
110
|
type: "string"
|
|
108
111
|
},
|
|
109
112
|
|
|
@@ -141,10 +144,6 @@ export class BaseProvider {
|
|
|
141
144
|
}
|
|
142
145
|
}
|
|
143
146
|
|
|
144
|
-
constructor(options, properties) {
|
|
145
|
-
definePropertiesFromOptions(this, options, properties);
|
|
146
|
-
}
|
|
147
|
-
|
|
148
147
|
/**
|
|
149
148
|
* @return {boolean} true if other provider is the same as the receiver
|
|
150
149
|
*/
|
|
@@ -401,6 +400,14 @@ export class BaseProvider {
|
|
|
401
400
|
return this.constructor.name;
|
|
402
401
|
}
|
|
403
402
|
|
|
403
|
+
/**
|
|
404
|
+
* @return {string} name
|
|
405
|
+
*/
|
|
406
|
+
get fullName()
|
|
407
|
+
{
|
|
408
|
+
return this.name;
|
|
409
|
+
}
|
|
410
|
+
|
|
404
411
|
/**
|
|
405
412
|
* We are our own provider.
|
|
406
413
|
* @return {BaseProvider} this
|