Skip to content

Commit fcc27fe

Browse files
GitHub Actionsjmagak
authored andcommitted
Update bulk import
1 parent db35060 commit fcc27fe

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

modules/importing-repositories/procedure-data-handoff-and-custom-workflow-design.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
= Data handoff and custom workflow design
66

7-
When you configure the Bulk Import plugin by setting the importAPI field to `scaffolder`, the Bulk Import Backend ensures all necessary context is passed directly to the Orchestrator.
7+
When you configure the Bulk Import plugin by setting the importAPI field to `scaffolder`, the Bulk Import Backend ensures all necessary context is passed directly to the Scaffolder API.
88

99
Your control over input data:: The Orchestrator workflow receives the input data required to automate processing for every selected repository. The payload includes, at minimum, the complete list of repository URLs and the user identity.
1010
+
@@ -21,10 +21,10 @@ Your control over input data:: The Orchestrator workflow receives the input data
2121
}
2222
----
2323

24-
As an administrator, you can define the Orchestrator workflow and structure the workflow to do the following:
24+
As an administrator, you can define the Scaffolder template workflow and structure the workflow to do the following:
2525

2626
Consume the input:: Accept the repositories array as primary input.
2727

2828
Iterate and process:: Loop through the list, executing the custom logic for example, creating the `catalog-info.yaml` if needed, then running compliance checks, then registering with the catalog.
2929

30-
Manage lifecycle:: The Orchestrator workflow owns the entire import lifecycle for the repository list, providing a single point of management and traceability.
30+
Manage lifecycle:: The Scaffolder template workflow owns the entire import lifecycle for the repository list, providing a single point of management and traceability.

modules/importing-repositories/procedure-integrating-bulk-import-with-orchestrator-workflows.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[id="integrating-bulk-import-with-orchestrator-workflows"]
44
= Setting up a custom scaffolder workflow for bulk import
55

6-
As an administrator, you can create a scaffolder template specifically for the Bulk Import plugin. You can provide the scaffolder template within the configuration of your application.
6+
As an administrator, you can create a scaffolder template specifically for the Bulk Import plugin. You can provide the Scaffolder template within the configuration of your application.
77

88
You can run the following tasks with this integration:
99

@@ -15,7 +15,7 @@ You can execute a custom automation workflow of a Scaffolder template on multipl
1515

1616
.Prerequisites
1717

18-
* You created a Scaffolder template specifically designed for the Bulk Import function and provided the scaffolder template within the configuration of your application. This template is the core definition of your customized import scenario.
18+
* You created a Scaffolder template specifically designed for the Bulk Import function and provided the Scaffolder template within the configuration of your application. This template is the core definition of your customized import scenario.
1919

2020
.Procedure
2121

@@ -28,26 +28,26 @@ To configure the Bulk Import workflow:
2828
----
2929
bulkImport:
3030
importTemplate: your-template-entity-reference-or-template-name
31-
importAPI: 'scaffolder'
31+
importAPI: `open-pull-requests` | `scaffolder`;
3232
----
3333
where:
3434

3535
`importTemplate:`::
36-
Enter your template entity reference or name of your Scaffolder template.
36+
Enter your Scaffolder template entity reference.
3737

3838
`importAPI`::
3939
Set the API to 'scaffolder' to trigger the defined workflow for high-fidelity automation. This field defines the import workflow and currently supports two following options:
4040

4141
`open-pull-requests`:: This is the default import workflow, which includes the logic for creating pull requests for every selected repository.
4242

43-
`scaffolder`:: This workflow uses an import scenario defined in the scaffolder template. Select this option to use the custom import scenario defined in your Scaffolder template.
43+
`scaffolder`:: This workflow uses an import scenario defined in the Scaffolder template to create import jobs. Select this option to use the custom import scenario defined in your Scaffolder template.
4444
+
4545
[IMPORTANT]
4646
====
4747
The Scaffolder template must be generic and not specific to a single repository if you want your custom Scaffolder template to run successfully for every repository in the bulk list.
4848
====
4949

50-
For the {product-very-short} instance to use the scaffolder functionality, you must run it with the following environment variable enabled:
50+
For the {product-very-short} instance to use the Scaffolder functionality, you must run it with the following environment variable enabled:
5151

5252
[source,yaml]
5353
----

0 commit comments

Comments
 (0)