@hostwebhook/node-types 1.71.0 → 1.71.1
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/dist/bucket-operations.js +12 -12
- package/dist/esm/bucket-operations.js +12 -12
- package/dist/esm/github-operations.js +67 -67
- package/dist/esm/jira-operations.js +47 -47
- package/dist/github-operations.js +67 -67
- package/dist/jira-operations.js +47 -47
- package/package.json +1 -1
|
@@ -108,7 +108,7 @@ const repo = () => ({
|
|
|
108
108
|
label: 'Repository',
|
|
109
109
|
type: 'githubRepo',
|
|
110
110
|
required: true,
|
|
111
|
-
description: '
|
|
111
|
+
description: 'From the repos this credential can reach. Stored as owner/repo.',
|
|
112
112
|
});
|
|
113
113
|
const issueNumber = (label = 'Issue number') => ({
|
|
114
114
|
name: 'issueNumber',
|
|
@@ -116,7 +116,7 @@ const issueNumber = (label = 'Issue number') => ({
|
|
|
116
116
|
type: 'template',
|
|
117
117
|
required: true,
|
|
118
118
|
placeholder: '{{payload.issue.number}}',
|
|
119
|
-
description: '
|
|
119
|
+
description: 'The number shown in the issue URL, not its internal id.',
|
|
120
120
|
});
|
|
121
121
|
const pullNumber = () => ({
|
|
122
122
|
name: 'pullNumber',
|
|
@@ -124,7 +124,7 @@ const pullNumber = () => ({
|
|
|
124
124
|
type: 'template',
|
|
125
125
|
required: true,
|
|
126
126
|
placeholder: '{{payload.pull_request.number}}',
|
|
127
|
-
description: '
|
|
127
|
+
description: 'The number shown in the PR URL, not its internal id.',
|
|
128
128
|
});
|
|
129
129
|
const perPage = () => ({
|
|
130
130
|
name: 'perPage',
|
|
@@ -134,13 +134,13 @@ const perPage = () => ({
|
|
|
134
134
|
min: 1,
|
|
135
135
|
max: 100,
|
|
136
136
|
advanced: true,
|
|
137
|
-
description: 'GitHub
|
|
137
|
+
description: 'GitHub never returns more than 100 per page.',
|
|
138
138
|
});
|
|
139
139
|
exports.GITHUB_OPERATION_SPECS = {
|
|
140
140
|
/* ── Issues ────────────────────────────────────────────────────────────── */
|
|
141
141
|
createIssue: {
|
|
142
142
|
label: 'Create issue',
|
|
143
|
-
description: '
|
|
143
|
+
description: 'Opens a new issue in the repository.',
|
|
144
144
|
apiRoute: 'POST /repos/{owner}/{repo}/issues',
|
|
145
145
|
params: [
|
|
146
146
|
repo(),
|
|
@@ -149,32 +149,32 @@ exports.GITHUB_OPERATION_SPECS = {
|
|
|
149
149
|
label: 'Title',
|
|
150
150
|
type: 'template',
|
|
151
151
|
required: true,
|
|
152
|
-
placeholder: '
|
|
152
|
+
placeholder: 'Payment failed: {{payload.order.id}}',
|
|
153
153
|
},
|
|
154
154
|
{
|
|
155
155
|
name: 'body',
|
|
156
156
|
label: 'Body',
|
|
157
157
|
type: 'textarea',
|
|
158
|
-
placeholder: '
|
|
159
|
-
description: '
|
|
158
|
+
placeholder: 'What came in:\n\n{{payload.message}}',
|
|
159
|
+
description: 'Supports Markdown, which is how GitHub will render it.',
|
|
160
160
|
},
|
|
161
161
|
{
|
|
162
162
|
name: 'labels',
|
|
163
163
|
label: 'Labels',
|
|
164
164
|
type: 'githubLabels',
|
|
165
|
-
description: '
|
|
165
|
+
description: 'From the ones that already exist in the repo.',
|
|
166
166
|
},
|
|
167
167
|
{
|
|
168
168
|
name: 'assignees',
|
|
169
169
|
label: 'Assignees',
|
|
170
170
|
type: 'githubAssignees',
|
|
171
|
-
description: '
|
|
171
|
+
description: 'Only people with access to the repo can be assigned.',
|
|
172
172
|
},
|
|
173
173
|
],
|
|
174
174
|
},
|
|
175
175
|
updateIssue: {
|
|
176
176
|
label: 'Update issue',
|
|
177
|
-
description: '
|
|
177
|
+
description: 'Changes title, body, state, labels or assignees.',
|
|
178
178
|
apiRoute: 'PATCH /repos/{owner}/{repo}/issues/{issue_number}',
|
|
179
179
|
params: [
|
|
180
180
|
repo(),
|
|
@@ -183,24 +183,24 @@ exports.GITHUB_OPERATION_SPECS = {
|
|
|
183
183
|
name: 'title',
|
|
184
184
|
label: 'New title',
|
|
185
185
|
type: 'template',
|
|
186
|
-
description: '
|
|
186
|
+
description: 'Leave empty to keep it unchanged.',
|
|
187
187
|
},
|
|
188
188
|
{
|
|
189
189
|
name: 'body',
|
|
190
190
|
label: 'New body',
|
|
191
191
|
type: 'textarea',
|
|
192
|
-
description: '
|
|
192
|
+
description: 'Leave empty to keep it unchanged. Replaces the whole body.',
|
|
193
193
|
},
|
|
194
194
|
{
|
|
195
195
|
name: 'state',
|
|
196
196
|
label: 'State',
|
|
197
197
|
type: 'select',
|
|
198
198
|
options: [
|
|
199
|
-
{ value: '', label: '—
|
|
200
|
-
{ value: 'open', label: 'Open (
|
|
201
|
-
{ value: 'closed', label: 'Closed (
|
|
199
|
+
{ value: '', label: '— leave as is —' },
|
|
200
|
+
{ value: 'open', label: 'Open (reopen it)' },
|
|
201
|
+
{ value: 'closed', label: 'Closed (close it)' },
|
|
202
202
|
],
|
|
203
|
-
description: '
|
|
203
|
+
description: 'Closing and reopening happen here; there is no separate operation.',
|
|
204
204
|
},
|
|
205
205
|
{
|
|
206
206
|
name: 'stateReason',
|
|
@@ -208,34 +208,34 @@ exports.GITHUB_OPERATION_SPECS = {
|
|
|
208
208
|
type: 'select',
|
|
209
209
|
showWhen: { field: 'state', in: ['closed'] },
|
|
210
210
|
options: [
|
|
211
|
-
{ value: 'completed', label: 'Completed —
|
|
212
|
-
{ value: 'not_planned', label: 'Not planned —
|
|
211
|
+
{ value: 'completed', label: 'Completed — it got resolved' },
|
|
212
|
+
{ value: 'not_planned', label: 'Not planned — it will not be done' },
|
|
213
213
|
],
|
|
214
|
-
description: '
|
|
214
|
+
description: 'This is what decides which icon GitHub draws when it closes.',
|
|
215
215
|
},
|
|
216
216
|
{
|
|
217
217
|
name: 'labels',
|
|
218
218
|
label: 'Labels',
|
|
219
219
|
type: 'githubLabels',
|
|
220
|
-
description: '
|
|
220
|
+
description: 'Careful: this REPLACES the issue labels, it does not add to them. Empty leaves them as they are.',
|
|
221
221
|
},
|
|
222
222
|
{
|
|
223
223
|
name: 'assignees',
|
|
224
224
|
label: 'Assignees',
|
|
225
225
|
type: 'githubAssignees',
|
|
226
|
-
description: '
|
|
226
|
+
description: 'Same as labels: it replaces, it does not add.',
|
|
227
227
|
},
|
|
228
228
|
],
|
|
229
229
|
},
|
|
230
230
|
getIssue: {
|
|
231
231
|
label: 'Get issue',
|
|
232
|
-
description: '
|
|
232
|
+
description: 'Reads an issue by its number.',
|
|
233
233
|
apiRoute: 'GET /repos/{owner}/{repo}/issues/{issue_number}',
|
|
234
234
|
params: [repo(), issueNumber()],
|
|
235
235
|
},
|
|
236
236
|
commentIssue: {
|
|
237
237
|
label: 'Comment on issue',
|
|
238
|
-
description: '
|
|
238
|
+
description: 'Adds a comment to an issue or a pull request.',
|
|
239
239
|
apiRoute: 'POST /repos/{owner}/{repo}/issues/{issue_number}/comments',
|
|
240
240
|
params: [
|
|
241
241
|
repo(),
|
|
@@ -245,14 +245,14 @@ exports.GITHUB_OPERATION_SPECS = {
|
|
|
245
245
|
label: 'Comment',
|
|
246
246
|
type: 'textarea',
|
|
247
247
|
required: true,
|
|
248
|
-
placeholder: '
|
|
249
|
-
description: '
|
|
248
|
+
placeholder: 'Deployed to production: {{payload.deployment.url}}',
|
|
249
|
+
description: 'Works for a PR too: in the GitHub API a pull request IS an issue.',
|
|
250
250
|
},
|
|
251
251
|
],
|
|
252
252
|
},
|
|
253
253
|
listIssues: {
|
|
254
254
|
label: 'List issues',
|
|
255
|
-
description: '
|
|
255
|
+
description: 'The repository issues, filterable. Returns a list.',
|
|
256
256
|
apiRoute: 'GET /repos/{owner}/{repo}/issues',
|
|
257
257
|
params: [
|
|
258
258
|
repo(),
|
|
@@ -264,20 +264,20 @@ exports.GITHUB_OPERATION_SPECS = {
|
|
|
264
264
|
options: [
|
|
265
265
|
{ value: 'open', label: 'Open' },
|
|
266
266
|
{ value: 'closed', label: 'Closed' },
|
|
267
|
-
{ value: 'all', label: '
|
|
267
|
+
{ value: 'all', label: 'All' },
|
|
268
268
|
],
|
|
269
269
|
},
|
|
270
270
|
{
|
|
271
271
|
name: 'labels',
|
|
272
272
|
label: 'With these labels',
|
|
273
273
|
type: 'githubLabels',
|
|
274
|
-
description: '
|
|
274
|
+
description: 'An issue has to carry them ALL to show up.',
|
|
275
275
|
},
|
|
276
276
|
{
|
|
277
277
|
name: 'assignee',
|
|
278
278
|
label: 'Assigned to',
|
|
279
279
|
type: 'githubAssignees',
|
|
280
|
-
description: '
|
|
280
|
+
description: 'A single person. Empty does not filter.',
|
|
281
281
|
},
|
|
282
282
|
perPage(),
|
|
283
283
|
],
|
|
@@ -285,7 +285,7 @@ exports.GITHUB_OPERATION_SPECS = {
|
|
|
285
285
|
/* ── Pull requests ─────────────────────────────────────────────────────── */
|
|
286
286
|
createPullRequest: {
|
|
287
287
|
label: 'Create pull request',
|
|
288
|
-
description: '
|
|
288
|
+
description: 'Opens a PR from one branch against another.',
|
|
289
289
|
apiRoute: 'POST /repos/{owner}/{repo}/pulls',
|
|
290
290
|
params: [
|
|
291
291
|
repo(),
|
|
@@ -294,21 +294,21 @@ exports.GITHUB_OPERATION_SPECS = {
|
|
|
294
294
|
label: 'Title',
|
|
295
295
|
type: 'template',
|
|
296
296
|
required: true,
|
|
297
|
-
placeholder: '
|
|
297
|
+
placeholder: 'Update dependencies — {{payload.date}}',
|
|
298
298
|
},
|
|
299
299
|
{
|
|
300
300
|
name: 'head',
|
|
301
301
|
label: 'From branch',
|
|
302
302
|
type: 'githubBranch',
|
|
303
303
|
required: true,
|
|
304
|
-
description: '
|
|
304
|
+
description: 'The branch with the changes. The one to be merged.',
|
|
305
305
|
},
|
|
306
306
|
{
|
|
307
307
|
name: 'base',
|
|
308
308
|
label: 'Into branch',
|
|
309
309
|
type: 'githubBranch',
|
|
310
310
|
required: true,
|
|
311
|
-
description: '
|
|
311
|
+
description: 'The target branch. Usually main.',
|
|
312
312
|
},
|
|
313
313
|
{ name: 'body', label: 'Description', type: 'textarea' },
|
|
314
314
|
{
|
|
@@ -316,9 +316,9 @@ exports.GITHUB_OPERATION_SPECS = {
|
|
|
316
316
|
label: 'Open as draft',
|
|
317
317
|
type: 'booleanSelect',
|
|
318
318
|
options: [
|
|
319
|
-
{ value: '', label: '—
|
|
320
|
-
{ value: 'true', label: '
|
|
321
|
-
{ value: 'false', label: 'No,
|
|
319
|
+
{ value: '', label: '— leave as is —' },
|
|
320
|
+
{ value: 'true', label: 'Yes, as a draft' },
|
|
321
|
+
{ value: 'false', label: 'No, ready for review' },
|
|
322
322
|
],
|
|
323
323
|
advanced: true,
|
|
324
324
|
},
|
|
@@ -326,13 +326,13 @@ exports.GITHUB_OPERATION_SPECS = {
|
|
|
326
326
|
},
|
|
327
327
|
getPullRequest: {
|
|
328
328
|
label: 'Get pull request',
|
|
329
|
-
description: '
|
|
329
|
+
description: 'Reads a PR by its number, with its merge state.',
|
|
330
330
|
apiRoute: 'GET /repos/{owner}/{repo}/pulls/{pull_number}',
|
|
331
331
|
params: [repo(), pullNumber()],
|
|
332
332
|
},
|
|
333
333
|
mergePullRequest: {
|
|
334
334
|
label: 'Merge pull request',
|
|
335
|
-
description: '
|
|
335
|
+
description: 'Merges an open PR.',
|
|
336
336
|
apiRoute: 'PUT /repos/{owner}/{repo}/pulls/{pull_number}/merge',
|
|
337
337
|
params: [
|
|
338
338
|
repo(),
|
|
@@ -347,14 +347,14 @@ exports.GITHUB_OPERATION_SPECS = {
|
|
|
347
347
|
{ value: 'squash', label: 'Squash and merge' },
|
|
348
348
|
{ value: 'rebase', label: 'Rebase and merge' },
|
|
349
349
|
],
|
|
350
|
-
description: '
|
|
350
|
+
description: 'The repo can have methods disabled in its settings; when the chosen one is not allowed, GitHub answers 405.',
|
|
351
351
|
},
|
|
352
352
|
{
|
|
353
353
|
name: 'commitTitle',
|
|
354
354
|
label: 'Commit title',
|
|
355
355
|
type: 'template',
|
|
356
356
|
advanced: true,
|
|
357
|
-
description: '
|
|
357
|
+
description: 'Empty keeps the one GitHub generates on its own.',
|
|
358
358
|
},
|
|
359
359
|
{
|
|
360
360
|
name: 'commitMessage',
|
|
@@ -366,7 +366,7 @@ exports.GITHUB_OPERATION_SPECS = {
|
|
|
366
366
|
},
|
|
367
367
|
listPullRequests: {
|
|
368
368
|
label: 'List pull requests',
|
|
369
|
-
description: '
|
|
369
|
+
description: 'The repository PRs, filterable. Returns a list.',
|
|
370
370
|
apiRoute: 'GET /repos/{owner}/{repo}/pulls',
|
|
371
371
|
params: [
|
|
372
372
|
repo(),
|
|
@@ -378,14 +378,14 @@ exports.GITHUB_OPERATION_SPECS = {
|
|
|
378
378
|
options: [
|
|
379
379
|
{ value: 'open', label: 'Open' },
|
|
380
380
|
{ value: 'closed', label: 'Closed' },
|
|
381
|
-
{ value: 'all', label: '
|
|
381
|
+
{ value: 'all', label: 'All' },
|
|
382
382
|
],
|
|
383
383
|
},
|
|
384
384
|
{
|
|
385
385
|
name: 'base',
|
|
386
386
|
label: 'Into branch',
|
|
387
387
|
type: 'githubBranch',
|
|
388
|
-
description: '
|
|
388
|
+
description: 'Only the ones targeting this branch. Empty does not filter.',
|
|
389
389
|
},
|
|
390
390
|
perPage(),
|
|
391
391
|
],
|
|
@@ -393,7 +393,7 @@ exports.GITHUB_OPERATION_SPECS = {
|
|
|
393
393
|
/* ── Contenido del repositorio ─────────────────────────────────────────── */
|
|
394
394
|
getFile: {
|
|
395
395
|
label: 'Get file',
|
|
396
|
-
description: '
|
|
396
|
+
description: 'Reads a file from the repository, already decoded.',
|
|
397
397
|
apiRoute: 'GET /repos/{owner}/{repo}/contents/{path}',
|
|
398
398
|
params: [
|
|
399
399
|
repo(),
|
|
@@ -403,19 +403,19 @@ exports.GITHUB_OPERATION_SPECS = {
|
|
|
403
403
|
type: 'template',
|
|
404
404
|
required: true,
|
|
405
405
|
placeholder: 'package.json',
|
|
406
|
-
description: '
|
|
406
|
+
description: 'Path from the repo root, no leading slash.',
|
|
407
407
|
},
|
|
408
408
|
{
|
|
409
409
|
name: 'ref',
|
|
410
410
|
label: 'Branch',
|
|
411
411
|
type: 'githubBranch',
|
|
412
|
-
description: '
|
|
412
|
+
description: 'Empty uses the repo default branch.',
|
|
413
413
|
},
|
|
414
414
|
],
|
|
415
415
|
},
|
|
416
416
|
createOrUpdateFile: {
|
|
417
417
|
label: 'Create or update file',
|
|
418
|
-
description: '
|
|
418
|
+
description: 'Writes a file and commits the change.',
|
|
419
419
|
apiRoute: 'PUT /repos/{owner}/{repo}/contents/{path}',
|
|
420
420
|
params: [
|
|
421
421
|
repo(),
|
|
@@ -425,33 +425,33 @@ exports.GITHUB_OPERATION_SPECS = {
|
|
|
425
425
|
type: 'template',
|
|
426
426
|
required: true,
|
|
427
427
|
placeholder: 'data/report.md',
|
|
428
|
-
description: '
|
|
428
|
+
description: 'When the file already exists it is updated; otherwise it is created. The node resolves the sha — you do not have to supply it.',
|
|
429
429
|
},
|
|
430
430
|
{
|
|
431
431
|
name: 'content',
|
|
432
432
|
label: 'Content',
|
|
433
433
|
type: 'textarea',
|
|
434
434
|
required: true,
|
|
435
|
-
description: '
|
|
435
|
+
description: 'Plain text. The node encodes it before sending it.',
|
|
436
436
|
},
|
|
437
437
|
{
|
|
438
438
|
name: 'commitMessage',
|
|
439
439
|
label: 'Commit message',
|
|
440
440
|
type: 'template',
|
|
441
441
|
required: true,
|
|
442
|
-
placeholder: '
|
|
442
|
+
placeholder: 'Update the {{payload.date}} report',
|
|
443
443
|
},
|
|
444
444
|
{
|
|
445
445
|
name: 'branch',
|
|
446
446
|
label: 'Branch',
|
|
447
447
|
type: 'githubBranch',
|
|
448
|
-
description: '
|
|
448
|
+
description: 'Empty commits to the repo default branch.',
|
|
449
449
|
},
|
|
450
450
|
],
|
|
451
451
|
},
|
|
452
452
|
createBranch: {
|
|
453
453
|
label: 'Create branch',
|
|
454
|
-
description: '
|
|
454
|
+
description: 'Creates a branch off another one.',
|
|
455
455
|
apiRoute: 'POST /repos/{owner}/{repo}/git/refs',
|
|
456
456
|
params: [
|
|
457
457
|
repo(),
|
|
@@ -461,21 +461,21 @@ exports.GITHUB_OPERATION_SPECS = {
|
|
|
461
461
|
type: 'template',
|
|
462
462
|
required: true,
|
|
463
463
|
placeholder: 'fix/{{payload.issue.number}}',
|
|
464
|
-
description: '
|
|
464
|
+
description: 'Without the refs/heads/ prefix — the node adds it.',
|
|
465
465
|
},
|
|
466
466
|
{
|
|
467
467
|
name: 'fromBranch',
|
|
468
468
|
label: 'From branch',
|
|
469
469
|
type: 'githubBranch',
|
|
470
470
|
required: true,
|
|
471
|
-
description: '
|
|
471
|
+
description: 'Where it starts from. The node resolves its tip sha from this name.',
|
|
472
472
|
},
|
|
473
473
|
],
|
|
474
474
|
},
|
|
475
475
|
/* ── Automatización ────────────────────────────────────────────────────── */
|
|
476
476
|
dispatchWorkflow: {
|
|
477
477
|
label: 'Run workflow',
|
|
478
|
-
description: '
|
|
478
|
+
description: 'Triggers a GitHub Actions workflow.',
|
|
479
479
|
apiRoute: 'POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches',
|
|
480
480
|
params: [
|
|
481
481
|
repo(),
|
|
@@ -484,14 +484,14 @@ exports.GITHUB_OPERATION_SPECS = {
|
|
|
484
484
|
label: 'Workflow',
|
|
485
485
|
type: 'githubWorkflow',
|
|
486
486
|
required: true,
|
|
487
|
-
description: '
|
|
487
|
+
description: 'Only the ones declaring workflow_dispatch show up: the rest cannot be triggered from outside.',
|
|
488
488
|
},
|
|
489
489
|
{
|
|
490
490
|
name: 'ref',
|
|
491
491
|
label: 'Branch or tag',
|
|
492
492
|
type: 'githubBranch',
|
|
493
493
|
required: true,
|
|
494
|
-
description: '
|
|
494
|
+
description: 'Which ref the workflow runs from.',
|
|
495
495
|
},
|
|
496
496
|
{
|
|
497
497
|
name: 'inputs',
|
|
@@ -499,14 +499,14 @@ exports.GITHUB_OPERATION_SPECS = {
|
|
|
499
499
|
type: 'json',
|
|
500
500
|
advanced: true,
|
|
501
501
|
placeholder: '{ "environment": "production" }',
|
|
502
|
-
description: '
|
|
502
|
+
description: 'The inputs the workflow declares. Flat object: GitHub only accepts strings as values.',
|
|
503
503
|
},
|
|
504
504
|
],
|
|
505
505
|
},
|
|
506
506
|
/* ── Transversal ───────────────────────────────────────────────────────── */
|
|
507
507
|
searchIssues: {
|
|
508
508
|
label: 'Search issues and PRs',
|
|
509
|
-
description: '
|
|
509
|
+
description: 'Searches all of GitHub with its search syntax. Returns a list.',
|
|
510
510
|
apiRoute: 'GET /search/issues',
|
|
511
511
|
params: [
|
|
512
512
|
{
|
|
@@ -515,17 +515,17 @@ exports.GITHUB_OPERATION_SPECS = {
|
|
|
515
515
|
type: 'template',
|
|
516
516
|
required: true,
|
|
517
517
|
placeholder: 'repo:hostwebhook/dashboard is:open label:bug',
|
|
518
|
-
description: '
|
|
518
|
+
description: 'The same syntax as the GitHub search bar. With no repo: it searches everything the credential can reach.',
|
|
519
519
|
},
|
|
520
520
|
{
|
|
521
521
|
name: 'sort',
|
|
522
522
|
label: 'Sort by',
|
|
523
523
|
type: 'select',
|
|
524
524
|
options: [
|
|
525
|
-
{ value: '', label: '
|
|
526
|
-
{ value: 'created', label: '
|
|
527
|
-
{ value: 'updated', label: '
|
|
528
|
-
{ value: 'comments', label: '
|
|
525
|
+
{ value: '', label: 'Relevance' },
|
|
526
|
+
{ value: 'created', label: 'Created date' },
|
|
527
|
+
{ value: 'updated', label: 'Last updated' },
|
|
528
|
+
{ value: 'comments', label: 'Comment count' },
|
|
529
529
|
],
|
|
530
530
|
advanced: true,
|
|
531
531
|
},
|
|
@@ -535,8 +535,8 @@ exports.GITHUB_OPERATION_SPECS = {
|
|
|
535
535
|
type: 'select',
|
|
536
536
|
default: 'desc',
|
|
537
537
|
options: [
|
|
538
|
-
{ value: 'desc', label: '
|
|
539
|
-
{ value: 'asc', label: '
|
|
538
|
+
{ value: 'desc', label: 'Descending' },
|
|
539
|
+
{ value: 'asc', label: 'Ascending' },
|
|
540
540
|
],
|
|
541
541
|
advanced: true,
|
|
542
542
|
},
|