feat(orchestrator): add GitLab among target repos of convertWorkflowToTemplate (#395)

Signed-off-by: Marek Libra <[email protected]>

Author: mareklibra

workspaces/orchestrator/app-config.yaml

@@ -43,9 +43,13 @@ backend:
   # workingDirectory: /tmp # Use this to configure a working directory for the scaffolder, defaults to the OS temp-dir
 
 integrations: {}
-# integrations:
-#   github:
-#     - token: ${GITHUB_TOKEN}
+#integrations:
+#  github:
+#    - host: github.com
+#      token: ${GITHUB_TOKEN}
+#  gitlab:
+#    - host: gitlab.com
+#      token: ${GITLAB_TOKEN}
 
 proxy:
   '/quay/api':

workspaces/orchestrator/entities/convertWorkflowToTemplate.yaml

@@ -34,6 +34,7 @@ spec:
           ui:options:
             allowedHosts:
               - github.com
+              - gitlab.com
         pluginLocation:
           type: string
           title: Where to publish this new plugin?
@@ -87,23 +88,48 @@ spec:
           repoName: ${{ (parameters.repoUrl | parseRepoUrl).repo }}
           orgName: ${{ (parameters.repoUrl | parseRepoUrl).owner }}
 
-    # This step publishes the contents of the working directory to GitHub if it is a new repository.
-    - id: publish
-      name: Publish the template in a new repository
-      if: ${{ parameters.pluginLocation === 'Create a new repository within the specified organization' }}
+    # GitHub: This step publishes the contents of the working directory to GitHub if it is a new repository.
+    - id: publishGithubRepo
+      name: Publish the template in a new GitHub repository
+      if: ${{ (parameters.repoUrl | parseRepoUrl).host === 'github.com' and parameters.pluginLocation === 'Create a new repository within the specified organization' }}
       action: publish:github
       input:
         allowedHosts: ['github.com']
         description: This is the template for the ${{ parameters.workflow_id }} workflow.
         repoUrl: ${{ parameters.repoUrl }}
         sourcePath: templates/${{parameters.workflow_id}}
 
-    # This step creates a pull request with the contents of the working directory.
+    # GitHub: This step creates a pull request with the contents of the working directory.
     - id: publishGithub
-      name: Create pull request with the template
-      if: ${{ parameters.pluginLocation  === 'Submit a pull request to the same repository' }}
+      name: Create GitHub pull request with the template
+      if: ${{ (parameters.repoUrl | parseRepoUrl).host === 'github.com' and parameters.pluginLocation  === 'Submit a pull request to the same repository' }}
       action: publish:github:pull-request
       input:
+        allowedHosts: ['github.com']
+        repoUrl: ${{ parameters.repoUrl }}
+        branchName: ${{ parameters.branchName }}
+        targetBranchName: ${{ parameters.targetBranchName }}
+        title: Create template ${{ parameters.workflow_id }}
+        description: This pull request creates template for running a workflow
+
+    # GitLab
+    - id: publishGitlabRepo
+      name: Publish the template in a new GitLab repository
+      action: publish:gitlab
+      if: ${{ (parameters.repoUrl | parseRepoUrl).host === 'gitlab.com' and parameters.pluginLocation === 'Create a new repository within the specified organization' }}
+      input:
+        allowedHosts: ['gitlab.com']
+        description: This is the template for the ${{ parameters.workflow_id }} workflow.
+        repoUrl: ${{ parameters.repoUrl }}
+        defaultBranch: main
+
+    # GitLab
+    - id: publishGitlab
+      name: Create GitLab merge request with the template
+      action: publish:gitlab:merge-request
+      if: ${{ (parameters.repoUrl | parseRepoUrl).host === 'gitlab.com' and parameters.pluginLocation === 'Submit a pull request to the same repository' }}
+      input:
+        allowedHosts: ['gitlab.com']
         repoUrl: ${{ parameters.repoUrl }}
         branchName: ${{ parameters.branchName }}
         targetBranchName: ${{ parameters.targetBranchName }}
@@ -112,7 +138,11 @@ spec:
 
   output:
     links:
-      - title: View Template
-        url: ${{ steps.publish.output.remoteUrl }}
-      - title: View Pull Request
+      - title: View template repository
+        url: ${{ steps.publishGithubRepo.output.remoteUrl }}
+      - title: View template repository
+        url: ${{ steps.publishGitlabRepo.output.remoteUrl }}
+      - title: View pull request with the template
         url: ${{ steps.publishGithub.output.remoteUrl }}
+      - title: View merge request with the template
+        url: ${{ steps.publishGitlab.output.mergeRequestUrl }}

workspaces/orchestrator/packages/backend/package.json

@@ -30,6 +30,7 @@
     "@backstage/plugin-auth-backend-module-guest-provider": "^0.2.1",
     "@backstage/plugin-auth-node": "^0.5.3",
     "@backstage/plugin-catalog-backend": "^1.27.1",
+    "@backstage/plugin-catalog-backend-module-gitlab": "^0.6.2",
     "@backstage/plugin-catalog-backend-module-logs": "^0.1.3",
     "@backstage/plugin-catalog-backend-module-scaffolder-entity-model": "^0.2.1",
     "@backstage/plugin-notifications-backend": "^0.4.3",
@@ -40,6 +41,7 @@
     "@backstage/plugin-proxy-backend": "^0.5.7",
     "@backstage/plugin-scaffolder-backend": "^1.26.2",
     "@backstage/plugin-scaffolder-backend-module-github": "^0.5.5",
+    "@backstage/plugin-scaffolder-backend-module-gitlab": "^0.7.1",
     "@backstage/plugin-search-backend": "^1.6.1",
     "@backstage/plugin-search-backend-module-catalog": "^0.2.4",
     "@backstage/plugin-search-backend-module-pg": "^0.5.37",

workspaces/orchestrator/packages/backend/src/index.ts

@@ -64,4 +64,7 @@ backend.add(import('backstage-plugin-scaffolder-backend-module-orchestrator'));
 // for integrating templates with github
 backend.add(import('@backstage/plugin-scaffolder-backend-module-github'));
 
+// for integrating templates with gitlab
+backend.add(import('@backstage/plugin-scaffolder-backend-module-gitlab'));
+
 backend.start();