Add a new module

Author: GitHub Actions

assemblies/assembly-bulk-importing-from-github.adoc

@@ -15,6 +15,8 @@ include::modules/importing-repositories/procedure-managing-the-imported-reposito
 
 include::modules/importing-repositories/procedure-understanding-bulk-import-audit-logs.adoc[leveloffset=+1]
 
+include::modules/importing-repositories/procedure-bulk-import-scaffolder-template.adoc[leveloffset=+1]
+
 include::modules/importing-repositories/procedure-integrating-bulk-import-with-orchestrator-workflows.adoc[leveloffset=+1]
 
 include::modules/importing-repositories/procedure-data-handoff-and-custom-workflow-design.adoc[leveloffset=+1]

modules/importing-repositories/procedure-bulk-import-scaffolder-template.adoc

@@ -0,0 +1,66 @@
+:_mod-docs-content-type: PROCEDURE
+
+[id="procedure-bulk-import-scaffolder-template"]
+= Understanding Bulk Import Scaffolder template input parameters
+
+You can use the Bulk Import plugin to run a Scaffolder template task with specified parameters. As an administrator, you must use these parameters within the template.
+
+The Bulk Import plugin analyzes Git repository information and provides the following parameters for the Scaffolder template task:
+
+`repoUrl`:: Normalized repository URL in the following format:
++
+[source,yaml]
+----
+  ${gitProviderHost}?owner=${owner}&repo=${repository-name}
+----
++
+For example, when you run the process, the plugin transforms `https://github.com/redhat-developer/rhdh-plugins` into `github.com?owner=redhat-developer&repo=rhdh-plugins`.
+
+`name`:: The repository name.
++
+For example, for `https://github.com/redhat-developer/rhdh-plugins`, the `name` is `rhdh-plugins`.
+
+`organization`:: The repository owner, which can be a user nickname or organization name.
++
+For example, for `https://github.com/redhat-developer/rhdh-plugins`, the `organization` is `redhat-developer`.
+
+`branchName`:: The proposed repository branch. By default, the proposed repository branch is `bulk-import-catalog-entity`.
+
+`targetBranchName`:: The default branch of the Git repository.
+
+`gitProviderHost`:: The Git provider host parsed from the repository URL.
++
+For example, for `https://github.com/redhat-developer/rhdh-plugins`, the `gitProviderHost` is `github.com`. You can use this parameter to write `Git-provider-agnostic` templates.
+
+To use parameters in a Scaffolder template:
+[source,yaml]
+----
+parameters:
+  - title: Repository Details
+    required:
+      - repoUrl
+      - branchName
+      - targetBranchName
+      - name
+      - organization
+    properties:
+      repoUrl:
+        type: string
+        title: Repository URL (Backstage format)
+        description: `github.com?owner=Org&repo=repoName` | `gitlab.com?owner=Org&repo=repoName`
+      organization:
+        type: string
+        title: Owner of the Repository
+      name:
+        type: string
+        title: Name of the repository
+      branchName:
+        type: string
+        title: Branch to add the catalog entity to
+      targetBranchName:
+        type: string
+        title: Branch to target the PR/MR to
+      gitProviderHost:
+        type: string
+        title: Git provider host
+----