@backstage/plugin-scaffolder-backend 1.19.2-next.2 → 1.19.2-next.3

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/index.d.ts CHANGED
@@ -2,13 +2,17 @@ import * as _backstage_plugin_scaffolder_node from '@backstage/plugin-scaffolder
2
2
  import { TemplateFilter as TemplateFilter$1, TemplateGlobal as TemplateGlobal$1, TemplateAction as TemplateAction$1, TaskStatus as TaskStatus$1, TaskCompletionState as TaskCompletionState$1, SerializedTask as SerializedTask$1, TaskEventType as TaskEventType$1, SerializedTaskEvent as SerializedTaskEvent$1, TaskBrokerDispatchResult as TaskBrokerDispatchResult$1, TaskBrokerDispatchOptions as TaskBrokerDispatchOptions$1, TaskContext as TaskContext$1, TaskBroker as TaskBroker$1, TaskSecrets as TaskSecrets$1, ActionContext as ActionContext$1, ExecuteShellCommandOptions, executeShellCommand as executeShellCommand$1, fetchContents as fetchContents$1 } from '@backstage/plugin-scaffolder-node';
3
3
  import * as _backstage_types from '@backstage/types';
4
4
  import { HumanDuration, JsonObject } from '@backstage/types';
5
- import { ScmIntegrations, ScmIntegrationRegistry, GithubCredentialsProvider } from '@backstage/integration';
5
+ import * as _backstage_integration from '@backstage/integration';
6
+ import { ScmIntegrations } from '@backstage/integration';
6
7
  import { CatalogApi } from '@backstage/catalog-client';
7
8
  import { UrlReader, PluginDatabaseManager } from '@backstage/backend-common';
8
9
  import { Config } from '@backstage/config';
9
10
  import { Duration } from 'luxon';
10
- import { Octokit } from 'octokit';
11
- import { createPullRequest } from 'octokit-plugin-create-pull-request';
11
+ import * as github from '@backstage/plugin-scaffolder-backend-module-github';
12
+ import * as gitlab from '@backstage/plugin-scaffolder-backend-module-gitlab';
13
+ import * as azure from '@backstage/plugin-scaffolder-backend-module-azure';
14
+ import * as bitbucket from '@backstage/plugin-scaffolder-backend-module-bitbucket';
15
+ import * as gerrit from '@backstage/plugin-scaffolder-backend-module-gerrit';
12
16
  import { Knex } from 'knex';
13
17
  import * as _backstage_plugin_scaffolder_common from '@backstage/plugin-scaffolder-common';
14
18
  import { TaskSpec, TemplateEntityStepV1beta3, TemplateParametersV1beta3 } from '@backstage/plugin-scaffolder-common';
@@ -109,8 +113,11 @@ interface CreateBuiltInActionsOptions {
109
113
  * A function to generate create a list of default actions that the scaffolder provides.
110
114
  * Is called internally in the default setup, but can be used when adding your own actions or overriding the default ones
111
115
  *
116
+ * TODO(blam): version 2 of the scaffolder shouldn't ship with the additional modules. We should ship the basics, and let people install
117
+ * modules for the providers they want to use.
112
118
  * @public
113
119
  * @returns A list of actions that can be used in the scaffolder
120
+ *
114
121
  */
115
122
  declare const createBuiltinActions: (options: CreateBuiltInActionsOptions) => TemplateAction$1[];
116
123
 
@@ -216,252 +223,45 @@ declare const createFilesystemRenameAction: () => _backstage_plugin_scaffolder_n
216
223
  }, _backstage_types.JsonObject>;
217
224
 
218
225
  /**
219
- * Creates a new action that initializes a git repository of the content in the workspace
220
- * and publishes it to Azure.
221
- * @public
226
+ * @public @deprecated use import from \@backstage/plugin-scaffolder-backend-module-github instead
222
227
  */
223
- declare function createPublishAzureAction(options: {
224
- integrations: ScmIntegrationRegistry;
225
- config: Config;
226
- }): _backstage_plugin_scaffolder_node.TemplateAction<{
227
- repoUrl: string;
228
- description?: string | undefined;
229
- defaultBranch?: string | undefined;
230
- sourcePath?: string | undefined;
231
- token?: string | undefined;
232
- gitCommitMessage?: string | undefined;
233
- gitAuthorName?: string | undefined;
234
- gitAuthorEmail?: string | undefined;
235
- }, _backstage_types.JsonObject>;
236
-
228
+ declare const createGithubActionsDispatchAction: typeof github.createGithubActionsDispatchAction;
237
229
  /**
238
- * Creates a new action that initializes a git repository of the content in the workspace
239
- * and publishes it to Bitbucket.
240
- * @public
241
- * @deprecated in favor of createPublishBitbucketCloudAction and createPublishBitbucketServerAction
230
+ * @public @deprecated use import from \@backstage/plugin-scaffolder-backend-module-github instead
242
231
  */
243
- declare function createPublishBitbucketAction(options: {
244
- integrations: ScmIntegrationRegistry;
245
- config: Config;
246
- }): _backstage_plugin_scaffolder_node.TemplateAction<{
247
- repoUrl: string;
248
- description?: string | undefined;
249
- defaultBranch?: string | undefined;
250
- repoVisibility?: "private" | "public" | undefined;
251
- sourcePath?: string | undefined;
252
- enableLFS?: boolean | undefined;
253
- token?: string | undefined;
254
- gitCommitMessage?: string | undefined;
255
- gitAuthorName?: string | undefined;
256
- gitAuthorEmail?: string | undefined;
257
- }, _backstage_types.JsonObject>;
258
-
232
+ declare const createGithubDeployKeyAction: typeof github.createGithubDeployKeyAction;
259
233
  /**
260
- * Creates a new action that initializes a git repository of the content in the workspace
261
- * and publishes it to Bitbucket Cloud.
262
- * @public
234
+ * @public @deprecated use import from \@backstage/plugin-scaffolder-backend-module-github instead
263
235
  */
264
- declare function createPublishBitbucketCloudAction(options: {
265
- integrations: ScmIntegrationRegistry;
266
- config: Config;
267
- }): _backstage_plugin_scaffolder_node.TemplateAction<{
268
- repoUrl: string;
269
- description?: string | undefined;
270
- defaultBranch?: string | undefined;
271
- repoVisibility?: "private" | "public" | undefined;
272
- sourcePath?: string | undefined;
273
- token?: string | undefined;
274
- }, _backstage_types.JsonObject>;
275
-
276
- /**
277
- * Creates a new action that initializes a git repository of the content in the workspace
278
- * and publishes it to Bitbucket Server.
279
- * @public
280
- */
281
- declare function createPublishBitbucketServerAction(options: {
282
- integrations: ScmIntegrationRegistry;
283
- config: Config;
284
- }): _backstage_plugin_scaffolder_node.TemplateAction<{
285
- repoUrl: string;
286
- description?: string | undefined;
287
- defaultBranch?: string | undefined;
288
- repoVisibility?: "private" | "public" | undefined;
289
- sourcePath?: string | undefined;
290
- enableLFS?: boolean | undefined;
291
- token?: string | undefined;
292
- gitCommitMessage?: string | undefined;
293
- gitAuthorName?: string | undefined;
294
- gitAuthorEmail?: string | undefined;
295
- }, _backstage_types.JsonObject>;
296
-
236
+ declare const createGithubEnvironmentAction: typeof github.createGithubEnvironmentAction;
297
237
  /**
298
- * Creates a BitbucketServer Pull Request action.
299
- * @public
238
+ * @public @deprecated use import from \@backstage/plugin-scaffolder-backend-module-github instead
300
239
  */
301
- declare function createPublishBitbucketServerPullRequestAction(options: {
302
- integrations: ScmIntegrationRegistry;
303
- config: Config;
304
- }): _backstage_plugin_scaffolder_node.TemplateAction<{
305
- repoUrl: string;
306
- title: string;
307
- description?: string | undefined;
308
- targetBranch?: string | undefined;
309
- sourceBranch: string;
310
- token?: string | undefined;
311
- }, _backstage_types.JsonObject>;
312
-
240
+ declare const createGithubIssuesLabelAction: typeof github.createGithubIssuesLabelAction;
313
241
  /**
314
- * Creates a new action that initializes a git repository of the content in the workspace
315
- * and publishes it to a Gerrit instance.
316
- * @public
242
+ * @public @deprecated use import from \@backstage/plugin-scaffolder-backend-module-github instead
317
243
  */
318
- declare function createPublishGerritAction(options: {
319
- integrations: ScmIntegrationRegistry;
320
- config: Config;
321
- }): _backstage_plugin_scaffolder_node.TemplateAction<{
322
- repoUrl: string;
323
- description: string;
324
- defaultBranch?: string | undefined;
325
- gitCommitMessage?: string | undefined;
326
- gitAuthorName?: string | undefined;
327
- gitAuthorEmail?: string | undefined;
328
- sourcePath?: string | undefined;
329
- }, _backstage_types.JsonObject>;
330
-
244
+ type CreateGithubPullRequestActionOptions = github.CreateGithubPullRequestActionOptions;
331
245
  /**
332
- * Creates a new action that creates a Gerrit review
333
- * @public
246
+ * @public @deprecated use import from \@backstage/plugin-scaffolder-backend-module-github instead
334
247
  */
335
- declare function createPublishGerritReviewAction(options: {
336
- integrations: ScmIntegrationRegistry;
337
- config: Config;
338
- }): _backstage_plugin_scaffolder_node.TemplateAction<{
339
- repoUrl: string;
340
- branch?: string | undefined;
341
- sourcePath?: string | undefined;
342
- gitCommitMessage?: string | undefined;
343
- gitAuthorName?: string | undefined;
344
- gitAuthorEmail?: string | undefined;
345
- }, _backstage_types.JsonObject>;
346
-
248
+ declare const createGithubRepoCreateAction: typeof github.createGithubRepoCreateAction;
347
249
  /**
348
- * Creates a new action that initializes a git repository of the content in the workspace
349
- * and publishes it to GitHub.
350
- *
351
- * @public
250
+ * @public @deprecated use import from \@backstage/plugin-scaffolder-backend-module-github instead
352
251
  */
353
- declare function createPublishGithubAction(options: {
354
- integrations: ScmIntegrationRegistry;
355
- config: Config;
356
- githubCredentialsProvider?: GithubCredentialsProvider;
357
- }): _backstage_plugin_scaffolder_node.TemplateAction<{
358
- repoUrl: string;
359
- description?: string | undefined;
360
- homepage?: string | undefined;
361
- access?: string | undefined;
362
- defaultBranch?: string | undefined;
363
- protectDefaultBranch?: boolean | undefined;
364
- protectEnforceAdmins?: boolean | undefined;
365
- deleteBranchOnMerge?: boolean | undefined;
366
- gitCommitMessage?: string | undefined;
367
- gitAuthorName?: string | undefined;
368
- gitAuthorEmail?: string | undefined;
369
- allowRebaseMerge?: boolean | undefined;
370
- allowSquashMerge?: boolean | undefined;
371
- squashMergeCommitTitle?: "PR_TITLE" | "COMMIT_OR_PR_TITLE" | undefined;
372
- squashMergeCommitMessage?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK" | undefined;
373
- allowMergeCommit?: boolean | undefined;
374
- allowAutoMerge?: boolean | undefined;
375
- sourcePath?: string | undefined;
376
- bypassPullRequestAllowances?: {
377
- users?: string[];
378
- teams?: string[];
379
- apps?: string[];
380
- } | undefined;
381
- requiredApprovingReviewCount?: number | undefined;
382
- restrictions?: {
383
- users: string[];
384
- teams: string[];
385
- apps?: string[];
386
- } | undefined;
387
- requireCodeOwnerReviews?: boolean | undefined;
388
- dismissStaleReviews?: boolean | undefined;
389
- requiredStatusCheckContexts?: string[] | undefined;
390
- requireBranchesToBeUpToDate?: boolean | undefined;
391
- requiredConversationResolution?: boolean | undefined;
392
- repoVisibility?: "internal" | "private" | "public" | undefined;
393
- collaborators?: ({
394
- user: string;
395
- access: string;
396
- } | {
397
- team: string;
398
- access: string;
399
- } | {
400
- /** @deprecated This field is deprecated in favor of team */
401
- username: string;
402
- access: 'pull' | 'push' | 'admin' | 'maintain' | 'triage';
403
- })[] | undefined;
404
- hasProjects?: boolean | undefined;
405
- hasWiki?: boolean | undefined;
406
- hasIssues?: boolean | undefined;
407
- token?: string | undefined;
408
- topics?: string[] | undefined;
409
- repoVariables?: {
410
- [key: string]: string;
411
- } | undefined;
412
- secrets?: {
413
- [key: string]: string;
414
- } | undefined;
415
- requiredCommitSigning?: boolean | undefined;
416
- }, _backstage_types.JsonObject>;
417
-
418
- /** @public */
419
- type OctokitWithPullRequestPluginClient = Octokit & {
420
- createPullRequest(options: createPullRequest.Options): Promise<{
421
- data: {
422
- html_url: string;
423
- number: number;
424
- base: {
425
- ref: string;
426
- };
427
- };
428
- } | null>;
429
- };
252
+ declare const createGithubRepoPushAction: typeof github.createGithubRepoPushAction;
430
253
  /**
431
- * The options passed to the client factory function.
432
- * @public
254
+ * @public @deprecated use import from \@backstage/plugin-scaffolder-backend-module-github instead
433
255
  */
434
- type CreateGithubPullRequestClientFactoryInput = {
435
- integrations: ScmIntegrationRegistry;
436
- githubCredentialsProvider?: GithubCredentialsProvider;
437
- host: string;
438
- owner: string;
439
- repo: string;
440
- token?: string;
441
- };
256
+ declare const createGithubWebhookAction: typeof github.createGithubWebhookAction;
442
257
  /**
443
- * The options passed to {@link createPublishGithubPullRequestAction} method
444
- * @public
258
+ * @public @deprecated use import from \@backstage/plugin-scaffolder-backend-module-github instead
445
259
  */
446
- interface CreateGithubPullRequestActionOptions {
447
- /**
448
- * An instance of {@link @backstage/integration#ScmIntegrationRegistry} that will be used in the action.
449
- */
450
- integrations: ScmIntegrationRegistry;
451
- /**
452
- * An instance of {@link @backstage/integration#GithubCredentialsProvider} that will be used to get credentials for the action.
453
- */
454
- githubCredentialsProvider?: GithubCredentialsProvider;
455
- /**
456
- * A method to return the Octokit client with the Pull Request Plugin.
457
- */
458
- clientFactory?: (input: CreateGithubPullRequestClientFactoryInput) => Promise<OctokitWithPullRequestPluginClient>;
459
- }
260
+ declare const createPublishGithubAction: typeof github.createPublishGithubAction;
460
261
  /**
461
- * Creates a Github Pull Request action.
462
- * @public
262
+ * @public @deprecated use import from \@backstage/plugin-scaffolder-backend-module-github instead
463
263
  */
464
- declare const createPublishGithubPullRequestAction: (options: CreateGithubPullRequestActionOptions) => _backstage_plugin_scaffolder_node.TemplateAction<{
264
+ declare const createPublishGithubPullRequestAction: (options: github.CreateGithubPullRequestActionOptions) => _backstage_plugin_scaffolder_node.TemplateAction<{
465
265
  title: string;
466
266
  branchName: string;
467
267
  targetBranchName?: string | undefined;
@@ -476,269 +276,56 @@ declare const createPublishGithubPullRequestAction: (options: CreateGithubPullRe
476
276
  commitMessage?: string | undefined;
477
277
  update?: boolean | undefined;
478
278
  }, _backstage_types.JsonObject>;
479
-
480
279
  /**
481
- * Creates a new action that initializes a git repository of the content in the workspace
482
- * and publishes it to GitLab.
483
- *
484
- * @public
280
+ * @public @deprecated use import from \@backstage/plugin-scaffolder-backend-module-bitbucket instead
485
281
  */
486
- declare function createPublishGitlabAction(options: {
487
- integrations: ScmIntegrationRegistry;
488
- config: Config;
489
- }): _backstage_plugin_scaffolder_node.TemplateAction<{
490
- repoUrl: string;
491
- defaultBranch?: string | undefined;
492
- /** @deprecated in favour of settings.visibility field */
493
- repoVisibility?: "internal" | "private" | "public" | undefined;
494
- sourcePath?: string | undefined;
495
- token?: string | undefined;
496
- gitCommitMessage?: string | undefined;
497
- gitAuthorName?: string | undefined;
498
- gitAuthorEmail?: string | undefined;
499
- setUserAsOwner?: boolean | undefined;
500
- /** @deprecated in favour of settings.topics field */
501
- topics?: string[] | undefined;
502
- settings?: {
503
- path?: string | undefined;
504
- auto_devops_enabled?: boolean | undefined;
505
- ci_config_path?: string | undefined;
506
- description?: string | undefined;
507
- topics?: string[] | undefined;
508
- visibility?: "internal" | "private" | "public" | undefined;
509
- } | undefined;
510
- branches?: {
511
- name: string;
512
- protect?: boolean | undefined;
513
- create?: boolean | undefined;
514
- ref?: string | undefined;
515
- }[] | undefined;
516
- projectVariables?: {
517
- key: string;
518
- value: string;
519
- description?: string | undefined;
520
- variable_type?: string | undefined;
521
- protected?: boolean | undefined;
522
- masked?: boolean | undefined;
523
- raw?: boolean | undefined;
524
- environment_scope?: string | undefined;
525
- }[] | undefined;
526
- }, _backstage_types.JsonObject>;
527
-
282
+ declare const createPublishBitbucketAction: typeof bitbucket.createPublishBitbucketAction;
528
283
  /**
529
- * Create a new action that creates a gitlab merge request.
530
- *
531
- * @public
284
+ * @public @deprecated use import from \@backstage/plugin-scaffolder-backend-module-bitbucket instead
532
285
  */
533
- declare const createPublishGitlabMergeRequestAction: (options: {
534
- integrations: ScmIntegrationRegistry;
535
- }) => _backstage_plugin_scaffolder_node.TemplateAction<{
536
- repoUrl: string;
537
- title: string;
538
- description: string;
539
- branchName: string;
540
- targetBranchName?: string | undefined;
541
- sourcePath?: string | undefined;
542
- targetPath?: string | undefined;
543
- token?: string | undefined;
544
- commitAction?: "update" | "delete" | "create" | undefined;
545
- /** @deprecated projectID passed as query parameters in the repoUrl */
546
- projectid?: string | undefined;
547
- removeSourceBranch?: boolean | undefined;
548
- assignee?: string | undefined;
549
- }, _backstage_types.JsonObject>;
550
-
286
+ declare const createPublishBitbucketCloudAction: typeof bitbucket.createPublishBitbucketCloudAction;
551
287
  /**
552
- * Creates a new action that dispatches a GitHub Action workflow for a given branch or tag.
553
- * @public
288
+ * @public @deprecated use import from \@backstage/plugin-scaffolder-backend-module-bitbucket instead
554
289
  */
555
- declare function createGithubActionsDispatchAction(options: {
556
- integrations: ScmIntegrations;
557
- githubCredentialsProvider?: GithubCredentialsProvider;
558
- }): _backstage_plugin_scaffolder_node.TemplateAction<{
559
- repoUrl: string;
560
- workflowId: string;
561
- branchOrTagName: string;
562
- workflowInputs?: {
563
- [key: string]: string;
564
- } | undefined;
565
- token?: string | undefined;
566
- }, _backstage_types.JsonObject>;
567
-
290
+ declare const createPublishBitbucketServerAction: typeof bitbucket.createPublishBitbucketServerAction;
568
291
  /**
569
- * Adds labels to a pull request or issue on GitHub
570
- * @public
292
+ * @public @deprecated use import from \@backstage/plugin-scaffolder-backend-module-bitbucket instead
571
293
  */
572
- declare function createGithubIssuesLabelAction(options: {
573
- integrations: ScmIntegrationRegistry;
574
- githubCredentialsProvider?: GithubCredentialsProvider;
575
- }): _backstage_plugin_scaffolder_node.TemplateAction<{
576
- repoUrl: string;
577
- number: number;
578
- labels: string[];
579
- token?: string | undefined;
580
- }, _backstage_types.JsonObject>;
581
-
294
+ declare const createPublishBitbucketServerPullRequestAction: typeof bitbucket.createPublishBitbucketServerPullRequestAction;
582
295
  /**
583
- * Creates a new action that initializes a git repository
584
- *
585
- * @public
296
+ * @public @deprecated use import from \@backstage/plugin-scaffolder-backend-module-azure instead
586
297
  */
587
- declare function createGithubRepoCreateAction(options: {
588
- integrations: ScmIntegrationRegistry;
589
- githubCredentialsProvider?: GithubCredentialsProvider;
590
- }): _backstage_plugin_scaffolder_node.TemplateAction<{
591
- repoUrl: string;
592
- description?: string | undefined;
593
- homepage?: string | undefined;
594
- access?: string | undefined;
595
- deleteBranchOnMerge?: boolean | undefined;
596
- gitAuthorName?: string | undefined;
597
- gitAuthorEmail?: string | undefined;
598
- allowRebaseMerge?: boolean | undefined;
599
- allowSquashMerge?: boolean | undefined;
600
- squashMergeCommitTitle?: "PR_TITLE" | "COMMIT_OR_PR_TITLE" | undefined;
601
- squashMergeCommitMessage?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK" | undefined;
602
- allowMergeCommit?: boolean | undefined;
603
- allowAutoMerge?: boolean | undefined;
604
- requireCodeOwnerReviews?: boolean | undefined;
605
- bypassPullRequestAllowances?: {
606
- users?: string[] | undefined;
607
- teams?: string[] | undefined;
608
- apps?: string[] | undefined;
609
- } | undefined;
610
- requiredApprovingReviewCount?: number | undefined;
611
- restrictions?: {
612
- users: string[];
613
- teams: string[];
614
- apps?: string[] | undefined;
615
- } | undefined;
616
- requiredStatusCheckContexts?: string[] | undefined;
617
- requireBranchesToBeUpToDate?: boolean | undefined;
618
- requiredConversationResolution?: boolean | undefined;
619
- repoVisibility?: "internal" | "private" | "public" | undefined;
620
- collaborators?: ({
621
- user: string;
622
- access: string;
623
- } | {
624
- team: string;
625
- access: string;
626
- } | {
627
- /** @deprecated This field is deprecated in favor of team */
628
- username: string;
629
- access: 'pull' | 'push' | 'admin' | 'maintain' | 'triage';
630
- })[] | undefined;
631
- hasProjects?: boolean | undefined;
632
- hasWiki?: boolean | undefined;
633
- hasIssues?: boolean | undefined;
634
- token?: string | undefined;
635
- topics?: string[] | undefined;
636
- repoVariables?: {
637
- [key: string]: string;
638
- } | undefined;
639
- secrets?: {
640
- [key: string]: string;
641
- } | undefined;
642
- requireCommitSigning?: boolean | undefined;
643
- }, _backstage_types.JsonObject>;
644
-
298
+ declare const createPublishAzureAction: typeof azure.createPublishAzureAction;
645
299
  /**
646
- * Creates a new action that initializes a git repository of the content in the workspace
647
- * and publishes it to GitHub.
648
- *
649
- * @public
300
+ * @public @deprecated use import from \@backstage/plugin-scaffolder-backend-module-gerrit instead
650
301
  */
651
- declare function createGithubRepoPushAction(options: {
652
- integrations: ScmIntegrationRegistry;
653
- config: Config;
654
- githubCredentialsProvider?: GithubCredentialsProvider;
655
- }): _backstage_plugin_scaffolder_node.TemplateAction<{
656
- repoUrl: string;
657
- description?: string | undefined;
658
- defaultBranch?: string | undefined;
659
- protectDefaultBranch?: boolean | undefined;
660
- protectEnforceAdmins?: boolean | undefined;
661
- gitCommitMessage?: string | undefined;
662
- gitAuthorName?: string | undefined;
663
- gitAuthorEmail?: string | undefined;
664
- requireCodeOwnerReviews?: boolean | undefined;
665
- dismissStaleReviews?: boolean | undefined;
666
- bypassPullRequestAllowances?: {
667
- users?: string[];
668
- teams?: string[];
669
- apps?: string[];
670
- } | undefined;
671
- requiredApprovingReviewCount?: number | undefined;
672
- restrictions?: {
673
- users: string[];
674
- teams: string[];
675
- apps?: string[];
676
- } | undefined;
677
- requiredStatusCheckContexts?: string[] | undefined;
678
- requireBranchesToBeUpToDate?: boolean | undefined;
679
- requiredConversationResolution?: boolean | undefined;
680
- sourcePath?: string | undefined;
681
- token?: string | undefined;
682
- requiredCommitSigning?: boolean | undefined;
683
- }, _backstage_types.JsonObject>;
684
-
302
+ declare const createPublishGerritAction: typeof gerrit.createPublishGerritAction;
685
303
  /**
686
- * Creates new action that creates a webhook for a repository on GitHub.
687
- * @public
304
+ * @public @deprecated use import from \@backstage/plugin-scaffolder-backend-module-gerrit instead
688
305
  */
689
- declare function createGithubWebhookAction(options: {
690
- integrations: ScmIntegrationRegistry;
691
- defaultWebhookSecret?: string;
692
- githubCredentialsProvider?: GithubCredentialsProvider;
693
- }): _backstage_plugin_scaffolder_node.TemplateAction<{
694
- repoUrl: string;
695
- webhookUrl: string;
696
- webhookSecret?: string | undefined;
697
- events?: string[] | undefined;
698
- active?: boolean | undefined;
699
- contentType?: "form" | "json" | undefined;
700
- insecureSsl?: boolean | undefined;
701
- token?: string | undefined;
702
- }, _backstage_types.JsonObject>;
703
-
306
+ declare const createPublishGerritReviewAction: typeof gerrit.createPublishGerritReviewAction;
704
307
  /**
705
- * Creates an `github:deployKey:create` Scaffolder action that creates a Deploy Key
706
- *
707
- * @public
308
+ * @public @deprecated use import from \@backstage/plugin-scaffolder-backend-module-gitlab instead
708
309
  */
709
- declare function createGithubDeployKeyAction(options: {
710
- integrations: ScmIntegrationRegistry;
711
- }): _backstage_plugin_scaffolder_node.TemplateAction<{
712
- repoUrl: string;
713
- publicKey: string;
714
- privateKey: string;
715
- deployKeyName: string;
716
- privateKeySecretName?: string | undefined;
717
- token?: string | undefined;
718
- }, _backstage_types.JsonObject>;
719
-
310
+ declare const createPublishGitlabAction: typeof gitlab.createPublishGitlabAction;
720
311
  /**
721
- * Creates an `github:environment:create` Scaffolder action that creates a Github Environment.
722
- *
723
- * @public
312
+ * @public @deprecated use import from \@backstage/plugin-scaffolder-backend-module-gitlab instead
724
313
  */
725
- declare function createGithubEnvironmentAction(options: {
726
- integrations: ScmIntegrationRegistry;
727
- }): _backstage_plugin_scaffolder_node.TemplateAction<{
314
+ declare const createPublishGitlabMergeRequestAction: (options: {
315
+ integrations: _backstage_integration.ScmIntegrationRegistry;
316
+ }) => _backstage_plugin_scaffolder_node.TemplateAction<{
728
317
  repoUrl: string;
729
- name: string;
730
- deploymentBranchPolicy?: {
731
- protected_branches: boolean;
732
- custom_branch_policies: boolean;
733
- } | undefined;
734
- customBranchPolicyNames?: string[] | undefined;
735
- environmentVariables?: {
736
- [key: string]: string;
737
- } | undefined;
738
- secrets?: {
739
- [key: string]: string;
740
- } | undefined;
318
+ title: string;
319
+ description: string;
320
+ branchName: string;
321
+ targetBranchName?: string | undefined;
322
+ sourcePath?: string | undefined;
323
+ targetPath?: string | undefined;
741
324
  token?: string | undefined;
325
+ commitAction?: "update" | "delete" | "create" | undefined;
326
+ projectid?: string | undefined;
327
+ removeSourceBranch?: boolean | undefined;
328
+ assignee?: string | undefined;
742
329
  }, _backstage_types.JsonObject>;
743
330
 
744
331
  /**
@@ -1132,4 +719,4 @@ declare const fetchContents: typeof fetchContents$1;
1132
719
  */
1133
720
  declare const ScaffolderEntitiesProcessor: typeof ScaffolderEntitiesProcessor$1;
1134
721
 
1135
- export { ActionContext, ActionPermissionRuleInput, CreateBuiltInActionsOptions, CreateGithubPullRequestActionOptions, CreateGithubPullRequestClientFactoryInput, CreateWorkerOptions, CurrentClaimedTask, DatabaseTaskStore, DatabaseTaskStoreOptions, OctokitWithPullRequestPluginClient, RouterOptions, RunCommandOptions, ScaffolderEntitiesProcessor, SerializedTask, SerializedTaskEvent, TaskBroker, TaskBrokerDispatchOptions, TaskBrokerDispatchResult, TaskCompletionState, TaskContext, TaskEventType, TaskManager, TaskSecrets, TaskStatus, TaskStore, TaskStoreCreateTaskOptions, TaskStoreCreateTaskResult, TaskStoreEmitOptions, TaskStoreListEventsOptions, TaskStoreShutDownTaskOptions, TaskWorker, TemplateAction, TemplateActionRegistry, TemplateFilter, TemplateGlobal, TemplatePermissionRuleInput, createBuiltinActions, createCatalogRegisterAction, createCatalogWriteAction, createDebugLogAction, createFetchCatalogEntityAction, createFetchPlainAction, createFetchPlainFileAction, createFetchTemplateAction, createFilesystemDeleteAction, createFilesystemRenameAction, createGithubActionsDispatchAction, createGithubDeployKeyAction, createGithubEnvironmentAction, createGithubIssuesLabelAction, createGithubRepoCreateAction, createGithubRepoPushAction, createGithubWebhookAction, createPublishAzureAction, createPublishBitbucketAction, createPublishBitbucketCloudAction, createPublishBitbucketServerAction, createPublishBitbucketServerPullRequestAction, createPublishGerritAction, createPublishGerritReviewAction, createPublishGithubAction, createPublishGithubPullRequestAction, createPublishGitlabAction, createPublishGitlabMergeRequestAction, createRouter, createTemplateAction, createWaitAction, executeShellCommand, fetchContents };
722
+ export { ActionContext, ActionPermissionRuleInput, CreateBuiltInActionsOptions, CreateGithubPullRequestActionOptions, CreateWorkerOptions, CurrentClaimedTask, DatabaseTaskStore, DatabaseTaskStoreOptions, RouterOptions, RunCommandOptions, ScaffolderEntitiesProcessor, SerializedTask, SerializedTaskEvent, TaskBroker, TaskBrokerDispatchOptions, TaskBrokerDispatchResult, TaskCompletionState, TaskContext, TaskEventType, TaskManager, TaskSecrets, TaskStatus, TaskStore, TaskStoreCreateTaskOptions, TaskStoreCreateTaskResult, TaskStoreEmitOptions, TaskStoreListEventsOptions, TaskStoreShutDownTaskOptions, TaskWorker, TemplateAction, TemplateActionRegistry, TemplateFilter, TemplateGlobal, TemplatePermissionRuleInput, createBuiltinActions, createCatalogRegisterAction, createCatalogWriteAction, createDebugLogAction, createFetchCatalogEntityAction, createFetchPlainAction, createFetchPlainFileAction, createFetchTemplateAction, createFilesystemDeleteAction, createFilesystemRenameAction, createGithubActionsDispatchAction, createGithubDeployKeyAction, createGithubEnvironmentAction, createGithubIssuesLabelAction, createGithubRepoCreateAction, createGithubRepoPushAction, createGithubWebhookAction, createPublishAzureAction, createPublishBitbucketAction, createPublishBitbucketCloudAction, createPublishBitbucketServerAction, createPublishBitbucketServerPullRequestAction, createPublishGerritAction, createPublishGerritReviewAction, createPublishGithubAction, createPublishGithubPullRequestAction, createPublishGitlabAction, createPublishGitlabMergeRequestAction, createRouter, createTemplateAction, createWaitAction, executeShellCommand, fetchContents };