@backstage/plugin-scaffolder-backend-module-gitlab 0.1.0-next.0

package/CHANGELOG.md

@@ -0,0 +1,15 @@
+# @backstage/plugin-scaffolder-backend-module-gitlab
+
+## 0.1.0-next.0
+
+### Minor Changes
+
+- 1ad400bb2de: Add Gitlab Scaffolder Plugin
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/plugin-scaffolder-node@0.1.2-next.0
+  - @backstage/config@1.0.7
+  - @backstage/integration@1.4.3
+  - @backstage/errors@1.1.5

package/README.md

@@ -0,0 +1,162 @@
+# scaffolder-backend-module-gitlab
+
+Welcome to the Gitlab Module for Scaffolder.
+
+Here you can find all Gitlab related features to improve your scaffolder:
+
+## Getting started
+
+## From your Backstage root directory
+
+```bash
+# From your Backstage root directory
+yarn add --cwd packages/backend @backstage/plugin-scaffolder-backend-module-gitlab
+```
+
+Configure the action:
+(you can check the [docs](https://backstage.io/docs/features/software-templates/writing-custom-actions#registering-custom-actions) to see all options):
+
+```typescript
+// packages/backend/src/plugins/scaffolder.ts
+
+import {
+  createGitlabProjectAccessTokenAction,
+  createGitlabProjectAccessTokenAction,
+  createGitlabProjectDeployTokenAction,
+} from '@backstage/plugin-scaffolder-backend-module-gitlab';
+
+// Create BuiltIn Actions
+const builtInActions = createBuiltinActions({
+  integrations,
+  catalogClient,
+  config: env.config,
+  reader: env.reader,
+});
+
+// Add Gitlab Actions
+const actions = [
+  ...builtInActions,
+  createGitlabProjectAccessTokenAction({
+    integrations: integrations,
+  }),
+  createGitlabProjectAccessTokenAction({
+    integrations: integrations,
+  }),
+  createGitlabProjectDeployTokenAction({
+    integrations: integrations,
+  }),
+];
+
+// Create Scaffolder Router
+return await createRouter({
+  containerRunner,
+  catalogClient,
+  actions,
+  logger: env.logger,
+  config: env.config,
+  database: env.database,
+  reader: env.reader,
+});
+```
+
+After that you can use the action in your template:
+
+```yaml
+apiVersion: scaffolder.backstage.io/v1beta3
+kind: Template
+metadata:
+  name: gitlab-demo
+  title: Gitlab DEMO
+  description: Scaffolder Gitlab Demo
+spec:
+  owner: backstage/techdocs-core
+  type: service
+
+  parameters:
+    - title: Fill in some steps
+      required:
+        - name
+      properties:
+        name:
+          title: Name
+          type: string
+          description: Unique name of the component
+          ui:autofocus: true
+          ui:options:
+            rows: 5
+    - title: Choose a location
+      required:
+        - repoUrl
+      properties:
+        repoUrl:
+          title: Repository Location
+          type: string
+          ui:field: RepoUrlPicker
+          ui:options:
+            allowedHosts:
+              - gitlab.com
+
+  steps:
+    - id: fetch
+      name: Fetch
+      action: fetch:template
+      input:
+        url: https://github.com/TEMPLATE
+        values:
+          name: ${{ parameters.name }}
+
+    - id: publish
+      name: Publish
+      action: publish:gitlab
+      input:
+        description: This is ${{ parameters.name }}
+        repoUrl: ${{ parameters.repoUrl }}
+        sourcePath: pimcore
+        defaultBranch: main
+
+    - id: gitlab-deploy-token
+      name: Create Deploy Token
+      action: gitlab:projectDeployToken:create
+      input:
+        repoUrl: ${{ parameters.repoUrl }}
+        projectId: "${{ steps['publish'].output.projectId }}"
+        name: ${{ parameters.name }}-secret
+        username: ${{ parameters.name }}-secret
+        scopes: ['read_registry']
+
+    - id: gitlab-access-token
+      name: Gitlab Project Access Token
+      action: gitlab:projectAccessToken:create
+      input:
+        repoUrl: ${{ parameters.repoUrl }}
+        projectId: "${{ steps['publish-manifest'].output.projectId }}"
+        name: ${{ parameters.name }}-access-token
+        accessLevel: 40
+        scopes: ['read_repository', 'write_repository']
+
+    - id: gitlab-project-variable
+      name: Gitlab Project Variable
+      action: gitlab:projectVariable:create
+      input:
+        repoUrl: ${{ parameters.repoUrl }}
+        projectId: "${{ steps['publish'].output.projectId }}"
+        key: 'VARIABLE_NAME'
+        value: "${{ steps['gitlab-access-token'].output.access_token }}"
+        variableType: 'env_var'
+        masked: true
+        variableProtected: false
+        raw: false
+        environmentScope: '*'
+
+    - id: register
+      name: Register
+      action: catalog:register
+      input:
+        repoContentsUrl: ${{ steps['publish'].output.repoContentsUrl }}
+        catalogInfoPath: '/catalog-info.yaml'
+
+  output:
+    links:
+      - title: Repository
+        url: ${{ steps['publish'].output.remoteUrl }}
+```

package/dist/index.cjs.js

@@ -0,0 +1,291 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var pluginScaffolderNode = require('@backstage/plugin-scaffolder-node');
+var node = require('@gitbeaker/node');
+var errors = require('@backstage/errors');
+
+const parseRepoHost = (repoUrl) => {
+  let parsed;
+  try {
+    parsed = new URL(`https://${repoUrl}`);
+  } catch (error) {
+    throw new errors.InputError(
+      `Invalid repo URL passed to publisher, got ${repoUrl}, ${error}`
+    );
+  }
+  return parsed.host;
+};
+const getToken = (repoUrl, inputToken, integrations) => {
+  const host = parseRepoHost(repoUrl);
+  const integrationConfig = integrations.gitlab.byHost(host);
+  if (!integrationConfig) {
+    throw new errors.InputError(
+      `No matching integration configuration for host ${host}, please check your integrations config`
+    );
+  }
+  const token = inputToken || integrationConfig.config.token;
+  const tokenType = inputToken ? "oauthToken" : "token";
+  if (tokenType === "oauthToken") {
+    throw new errors.InputError(`OAuth Token is currently not supported`);
+  }
+  return { token, integrationConfig };
+};
+
+const createGitlabProjectDeployTokenAction = (options) => {
+  const { integrations } = options;
+  return pluginScaffolderNode.createTemplateAction({
+    id: "gitlab:projectDeployToken:create",
+    schema: {
+      input: {
+        required: ["projectId", "repoUrl"],
+        type: "object",
+        properties: {
+          repoUrl: {
+            title: "Repository Location",
+            type: "string"
+          },
+          projectId: {
+            title: "Project ID",
+            type: ["string", "number"]
+          },
+          name: {
+            title: "Deploy Token Name",
+            type: "string"
+          },
+          username: {
+            title: "Deploy Token Username",
+            type: "string"
+          },
+          scopes: {
+            title: "Scopes",
+            type: "array"
+          },
+          token: {
+            title: "Authentication Token",
+            type: "string",
+            description: "The token to use for authorization to GitLab"
+          }
+        }
+      },
+      output: {
+        type: "object",
+        properties: {
+          deploy_token: {
+            title: "Deploy Token",
+            type: "string"
+          },
+          user: {
+            title: "User",
+            type: "string"
+          }
+        }
+      }
+    },
+    async handler(ctx) {
+      ctx.logger.info(`Creating Token for Project "${ctx.input.projectId}"`);
+      const { repoUrl, projectId, name, username, scopes } = ctx.input;
+      const { token, integrationConfig } = getToken(
+        repoUrl,
+        ctx.input.token,
+        integrations
+      );
+      const api = new node.Gitlab({
+        host: integrationConfig.config.baseUrl,
+        token
+      });
+      const deployToken = await api.ProjectDeployTokens.add(
+        projectId,
+        name,
+        scopes,
+        {
+          username
+        }
+      );
+      if (!deployToken.hasOwnProperty("token")) {
+        throw new errors.InputError(`No deploy_token given from gitlab instance`);
+      }
+      ctx.output("deploy_token", deployToken.token);
+      ctx.output("user", deployToken.username);
+    }
+  });
+};
+
+const createGitlabProjectAccessTokenAction = (options) => {
+  const { integrations } = options;
+  return pluginScaffolderNode.createTemplateAction({
+    id: "gitlab:projectAccessToken:create",
+    schema: {
+      input: {
+        required: ["projectId", "repoUrl"],
+        type: "object",
+        properties: {
+          repoUrl: {
+            title: "Repository Location",
+            type: "string"
+          },
+          projectId: {
+            title: "Project ID",
+            type: ["string", "number"]
+          },
+          name: {
+            title: "Deploy Token Name",
+            type: "string"
+          },
+          accessLevel: {
+            title: "Access Level of the Token",
+            type: "number"
+          },
+          scopes: {
+            title: "Scopes",
+            type: "array"
+          },
+          token: {
+            title: "Authentication Token",
+            type: "string",
+            description: "The token to use for authorization to GitLab"
+          }
+        }
+      },
+      output: {
+        type: "object",
+        properties: {
+          access_token: {
+            title: "Access Token",
+            type: "string"
+          }
+        }
+      }
+    },
+    async handler(ctx) {
+      ctx.logger.info(`Creating Token for Project "${ctx.input.projectId}"`);
+      const { repoUrl, projectId, name, accessLevel, scopes } = ctx.input;
+      const { token, integrationConfig } = getToken(
+        repoUrl,
+        ctx.input.token,
+        integrations
+      );
+      const response = await fetch(
+        `${integrationConfig.config.baseUrl}/api/v4/projects/${projectId}/access_tokens`,
+        {
+          method: "POST",
+          // *GET, POST, PUT, DELETE, etc.
+          headers: {
+            "PRIVATE-TOKEN": token,
+            "Content-Type": "application/json"
+          },
+          body: JSON.stringify({
+            name,
+            scopes,
+            access_level: accessLevel
+          })
+        }
+      );
+      const result = await response.json();
+      ctx.output("access_token", result.token);
+    }
+  });
+};
+
+const createGitlabProjectVariableAction = (options) => {
+  const { integrations } = options;
+  return pluginScaffolderNode.createTemplateAction({
+    id: "gitlab:projectVariable:create",
+    schema: {
+      input: {
+        required: [
+          "repoUrl",
+          "projectId",
+          "key",
+          "value",
+          "variableType",
+          "variableProtected",
+          "masked",
+          "raw",
+          "environmentScope"
+        ],
+        type: "object",
+        properties: {
+          repoUrl: {
+            title: "Repository Location",
+            type: "string"
+          },
+          projectId: {
+            title: "Project ID",
+            type: ["string", "number"]
+          },
+          key: {
+            title: "The key of a variable; must have no more than 255 characters; only A-Z, a-z, 0-9, and _ are allowed",
+            type: "string"
+          },
+          value: {
+            title: "The value of a variable",
+            type: "string"
+          },
+          variableType: {
+            title: "Variable Type (env_var or file)",
+            type: "string"
+          },
+          variableProtected: {
+            title: "Whether the variable is protected. Default: false",
+            type: "boolean"
+          },
+          masked: {
+            title: "Whether the variable is masked. Default: false",
+            type: "boolean"
+          },
+          raw: {
+            title: "Whether the variable is expandable. Default: false",
+            type: "boolean"
+          },
+          environmentScope: {
+            title: "The environment_scope of the variable. Default: *",
+            type: "string"
+          },
+          token: {
+            title: "Authentication Token",
+            type: "string",
+            description: "The token to use for authorization to GitLab"
+          }
+        }
+      }
+    },
+    async handler(ctx) {
+      const {
+        repoUrl,
+        projectId,
+        key,
+        value,
+        variableType,
+        variableProtected,
+        masked,
+        raw,
+        environmentScope
+      } = ctx.input;
+      const { token, integrationConfig } = getToken(
+        repoUrl,
+        ctx.input.token,
+        integrations
+      );
+      const api = new node.Gitlab({
+        host: integrationConfig.config.baseUrl,
+        token
+      });
+      await api.ProjectVariables.create(projectId, {
+        key,
+        value,
+        variable_type: variableType,
+        protected: variableProtected,
+        masked,
+        raw,
+        environment_scope: environmentScope
+      });
+    }
+  });
+};
+
+exports.createGitlabProjectAccessTokenAction = createGitlabProjectAccessTokenAction;
+exports.createGitlabProjectDeployTokenAction = createGitlabProjectDeployTokenAction;
+exports.createGitlabProjectVariableAction = createGitlabProjectVariableAction;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":["../src/util.ts","../src/actions/createGitlabProjectDeployTokenAction.ts","../src/actions/createGitlabProjectAccessTokenAction.ts","../src/actions/createGitlabProjectVariableAction.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { InputError } from '@backstage/errors';\nimport {\n  GitLabIntegration,\n  ScmIntegrationRegistry,\n} from '@backstage/integration';\n\nexport const parseRepoHost = (repoUrl: string): string => {\n  let parsed;\n  try {\n    parsed = new URL(`https://${repoUrl}`);\n  } catch (error) {\n    throw new InputError(\n      `Invalid repo URL passed to publisher, got ${repoUrl}, ${error}`,\n    );\n  }\n  return parsed.host;\n};\n\nexport const getToken = (\n  repoUrl: string,\n  inputToken: string | null | undefined,\n  integrations: ScmIntegrationRegistry,\n): { token: string; integrationConfig: GitLabIntegration } => {\n  const host = parseRepoHost(repoUrl);\n  const integrationConfig = integrations.gitlab.byHost(host);\n\n  if (!integrationConfig) {\n    throw new InputError(\n      `No matching integration configuration for host ${host}, please check your integrations config`,\n    );\n  }\n\n  const token = inputToken || integrationConfig.config.token!;\n  const tokenType = inputToken ? 'oauthToken' : 'token';\n\n  if (tokenType === 'oauthToken') {\n    throw new InputError(`OAuth Token is currently not supported`);\n  }\n\n  return { token: token, integrationConfig: integrationConfig };\n};\n","/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createTemplateAction } from '@backstage/plugin-scaffolder-node';\nimport { Gitlab } from '@gitbeaker/node';\nimport { ScmIntegrationRegistry } from '@backstage/integration';\nimport { DeployTokenScope } from '@gitbeaker/core/dist/types/templates/ResourceDeployTokens';\nimport { getToken } from '../util';\nimport { InputError } from '@backstage/errors';\n\n/**\n * Creates a `gitlab:create-project-deploy-token` Scaffolder action.\n *\n * @param options - Templating configuration.\n * @public\n */\nexport const createGitlabProjectDeployTokenAction = (options: {\n  integrations: ScmIntegrationRegistry;\n}) => {\n  const { integrations } = options;\n  return createTemplateAction<{\n    repoUrl: string;\n    projectId: string | number;\n    name: string;\n    username: string;\n    scopes: string[];\n    token?: string;\n  }>({\n    id: 'gitlab:projectDeployToken:create',\n    schema: {\n      input: {\n        required: ['projectId', 'repoUrl'],\n        type: 'object',\n        properties: {\n          repoUrl: {\n            title: 'Repository Location',\n            type: 'string',\n          },\n          projectId: {\n            title: 'Project ID',\n            type: ['string', 'number'],\n          },\n          name: {\n            title: 'Deploy Token Name',\n            type: 'string',\n          },\n          username: {\n            title: 'Deploy Token Username',\n            type: 'string',\n          },\n          scopes: {\n            title: 'Scopes',\n            type: 'array',\n          },\n          token: {\n            title: 'Authentication Token',\n            type: 'string',\n            description: 'The token to use for authorization to GitLab',\n          },\n        },\n      },\n      output: {\n        type: 'object',\n        properties: {\n          deploy_token: {\n            title: 'Deploy Token',\n            type: 'string',\n          },\n          user: {\n            title: 'User',\n            type: 'string',\n          },\n        },\n      },\n    },\n    async handler(ctx) {\n      ctx.logger.info(`Creating Token for Project \"${ctx.input.projectId}\"`);\n      const { repoUrl, projectId, name, username, scopes } = ctx.input;\n      const { token, integrationConfig } = getToken(\n        repoUrl,\n        ctx.input.token,\n        integrations,\n      );\n\n      const api = new Gitlab({\n        host: integrationConfig.config.baseUrl,\n        token: token,\n      });\n\n      const deployToken = await api.ProjectDeployTokens.add(\n        projectId,\n        name,\n        scopes as DeployTokenScope[],\n        {\n          username: username,\n        },\n      );\n\n      if (!deployToken.hasOwnProperty('token')) {\n        throw new InputError(`No deploy_token given from gitlab instance`);\n      }\n\n      ctx.output('deploy_token', deployToken.token as string);\n      ctx.output('user', deployToken.username);\n    },\n  });\n};\n","/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createTemplateAction } from '@backstage/plugin-scaffolder-node';\nimport { ScmIntegrationRegistry } from '@backstage/integration';\nimport { getToken } from '../util';\n\n/**\n * Creates a `gitlab:create-project-access-token` Scaffolder action.\n *\n * @param options - Templating configuration.\n * @public\n */\nexport const createGitlabProjectAccessTokenAction = (options: {\n  integrations: ScmIntegrationRegistry;\n}) => {\n  const { integrations } = options;\n  return createTemplateAction<{\n    repoUrl: string;\n    projectId: string | number;\n    name: string;\n    accessLevel: number;\n    scopes: string[];\n    token?: string;\n  }>({\n    id: 'gitlab:projectAccessToken:create',\n    schema: {\n      input: {\n        required: ['projectId', 'repoUrl'],\n        type: 'object',\n        properties: {\n          repoUrl: {\n            title: 'Repository Location',\n            type: 'string',\n          },\n          projectId: {\n            title: 'Project ID',\n            type: ['string', 'number'],\n          },\n          name: {\n            title: 'Deploy Token Name',\n            type: 'string',\n          },\n          accessLevel: {\n            title: 'Access Level of the Token',\n            type: 'number',\n          },\n          scopes: {\n            title: 'Scopes',\n            type: 'array',\n          },\n          token: {\n            title: 'Authentication Token',\n            type: 'string',\n            description: 'The token to use for authorization to GitLab',\n          },\n        },\n      },\n      output: {\n        type: 'object',\n        properties: {\n          access_token: {\n            title: 'Access Token',\n            type: 'string',\n          },\n        },\n      },\n    },\n    async handler(ctx) {\n      ctx.logger.info(`Creating Token for Project \"${ctx.input.projectId}\"`);\n      const { repoUrl, projectId, name, accessLevel, scopes } = ctx.input;\n      const { token, integrationConfig } = getToken(\n        repoUrl,\n        ctx.input.token,\n        integrations,\n      );\n\n      const response = await fetch(\n        `${integrationConfig.config.baseUrl}/api/v4/projects/${projectId}/access_tokens`,\n        {\n          method: 'POST', // *GET, POST, PUT, DELETE, etc.\n          headers: {\n            'PRIVATE-TOKEN': token,\n            'Content-Type': 'application/json',\n          },\n          body: JSON.stringify({\n            name: name,\n            scopes: scopes,\n            access_level: accessLevel,\n          }),\n        },\n      );\n\n      const result = await response.json();\n\n      ctx.output('access_token', result.token);\n    },\n  });\n};\n","/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createTemplateAction } from '@backstage/plugin-scaffolder-node';\nimport { ScmIntegrationRegistry } from '@backstage/integration';\nimport { getToken } from '../util';\nimport { Gitlab } from '@gitbeaker/node';\n\n/**\n * Creates a `gitlab:create-project-variable` Scaffolder action.\n *\n * @param options - Templating configuration.\n * @public\n */\nexport const createGitlabProjectVariableAction = (options: {\n  integrations: ScmIntegrationRegistry;\n}) => {\n  const { integrations } = options;\n  return createTemplateAction<{\n    repoUrl: string;\n    projectId: string | number;\n    key: string;\n    value: string;\n    variableType: string;\n    variableProtected: boolean;\n    masked: boolean;\n    raw: boolean;\n    environmentScope: string;\n    token?: string;\n  }>({\n    id: 'gitlab:projectVariable:create',\n    schema: {\n      input: {\n        required: [\n          'repoUrl',\n          'projectId',\n          'key',\n          'value',\n          'variableType',\n          'variableProtected',\n          'masked',\n          'raw',\n          'environmentScope',\n        ],\n        type: 'object',\n        properties: {\n          repoUrl: {\n            title: 'Repository Location',\n            type: 'string',\n          },\n          projectId: {\n            title: 'Project ID',\n            type: ['string', 'number'],\n          },\n          key: {\n            title:\n              'The key of a variable; must have no more than 255 characters; only A-Z, a-z, 0-9, and _ are allowed',\n            type: 'string',\n          },\n          value: {\n            title: 'The value of a variable',\n            type: 'string',\n          },\n          variableType: {\n            title: 'Variable Type (env_var or file)',\n            type: 'string',\n          },\n          variableProtected: {\n            title: 'Whether the variable is protected. Default: false',\n            type: 'boolean',\n          },\n          masked: {\n            title: 'Whether the variable is masked. Default: false',\n            type: 'boolean',\n          },\n          raw: {\n            title: 'Whether the variable is expandable. Default: false',\n            type: 'boolean',\n          },\n          environmentScope: {\n            title: 'The environment_scope of the variable. Default: *',\n            type: 'string',\n          },\n          token: {\n            title: 'Authentication Token',\n            type: 'string',\n            description: 'The token to use for authorization to GitLab',\n          },\n        },\n      },\n    },\n    async handler(ctx) {\n      const {\n        repoUrl,\n        projectId,\n        key,\n        value,\n        variableType,\n        variableProtected,\n        masked,\n        raw,\n        environmentScope,\n      } = ctx.input;\n      const { token, integrationConfig } = getToken(\n        repoUrl,\n        ctx.input.token,\n        integrations,\n      );\n\n      const api = new Gitlab({\n        host: integrationConfig.config.baseUrl,\n        token: token,\n      });\n\n      await api.ProjectVariables.create(projectId, {\n        key: key,\n        value: value,\n        variable_type: variableType,\n        protected: variableProtected,\n        masked: masked,\n        raw: raw,\n        environment_scope: environmentScope,\n      });\n    },\n  });\n};\n"],"names":["InputError","createTemplateAction","Gitlab"],"mappings":";;;;;;;;AAsBa,MAAA,aAAA,GAAgB,CAAC,OAA4B,KAAA;AACxD,EAAI,IAAA,MAAA,CAAA;AACJ,EAAI,IAAA;AACF,IAAS,MAAA,GAAA,IAAI,GAAI,CAAA,CAAA,QAAA,EAAW,OAAS,CAAA,CAAA,CAAA,CAAA;AAAA,WAC9B,KAAP,EAAA;AACA,IAAA,MAAM,IAAIA,iBAAA;AAAA,MACR,6CAA6C,OAAY,CAAA,EAAA,EAAA,KAAA,CAAA,CAAA;AAAA,KAC3D,CAAA;AAAA,GACF;AACA,EAAA,OAAO,MAAO,CAAA,IAAA,CAAA;AAChB,CAAA,CAAA;AAEO,MAAM,QAAW,GAAA,CACtB,OACA,EAAA,UAAA,EACA,YAC4D,KAAA;AAC5D,EAAM,MAAA,IAAA,GAAO,cAAc,OAAO,CAAA,CAAA;AAClC,EAAA,MAAM,iBAAoB,GAAA,YAAA,CAAa,MAAO,CAAA,MAAA,CAAO,IAAI,CAAA,CAAA;AAEzD,EAAA,IAAI,CAAC,iBAAmB,EAAA;AACtB,IAAA,MAAM,IAAIA,iBAAA;AAAA,MACR,CAAkD,+CAAA,EAAA,IAAA,CAAA,uCAAA,CAAA;AAAA,KACpD,CAAA;AAAA,GACF;AAEA,EAAM,MAAA,KAAA,GAAQ,UAAc,IAAA,iBAAA,CAAkB,MAAO,CAAA,KAAA,CAAA;AACrD,EAAM,MAAA,SAAA,GAAY,aAAa,YAAe,GAAA,OAAA,CAAA;AAE9C,EAAA,IAAI,cAAc,YAAc,EAAA;AAC9B,IAAM,MAAA,IAAIA,kBAAW,CAAwC,sCAAA,CAAA,CAAA,CAAA;AAAA,GAC/D;AAEA,EAAO,OAAA,EAAE,OAAc,iBAAqC,EAAA,CAAA;AAC9D,CAAA;;AC3Ba,MAAA,oCAAA,GAAuC,CAAC,OAE/C,KAAA;AACJ,EAAM,MAAA,EAAE,cAAiB,GAAA,OAAA,CAAA;AACzB,EAAA,OAAOC,yCAOJ,CAAA;AAAA,IACD,EAAI,EAAA,kCAAA;AAAA,IACJ,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,QAAA,EAAU,CAAC,WAAA,EAAa,SAAS,CAAA;AAAA,QACjC,IAAM,EAAA,QAAA;AAAA,QACN,UAAY,EAAA;AAAA,UACV,OAAS,EAAA;AAAA,YACP,KAAO,EAAA,qBAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,UACA,SAAW,EAAA;AAAA,YACT,KAAO,EAAA,YAAA;AAAA,YACP,IAAA,EAAM,CAAC,QAAA,EAAU,QAAQ,CAAA;AAAA,WAC3B;AAAA,UACA,IAAM,EAAA;AAAA,YACJ,KAAO,EAAA,mBAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,UACA,QAAU,EAAA;AAAA,YACR,KAAO,EAAA,uBAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,UACA,MAAQ,EAAA;AAAA,YACN,KAAO,EAAA,QAAA;AAAA,YACP,IAAM,EAAA,OAAA;AAAA,WACR;AAAA,UACA,KAAO,EAAA;AAAA,YACL,KAAO,EAAA,sBAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,YACN,WAAa,EAAA,8CAAA;AAAA,WACf;AAAA,SACF;AAAA,OACF;AAAA,MACA,MAAQ,EAAA;AAAA,QACN,IAAM,EAAA,QAAA;AAAA,QACN,UAAY,EAAA;AAAA,UACV,YAAc,EAAA;AAAA,YACZ,KAAO,EAAA,cAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,UACA,IAAM,EAAA;AAAA,YACJ,KAAO,EAAA,MAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,SACF;AAAA,OACF;AAAA,KACF;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAA,GAAA,CAAI,MAAO,CAAA,IAAA,CAAK,CAA+B,4BAAA,EAAA,GAAA,CAAI,MAAM,SAAY,CAAA,CAAA,CAAA,CAAA,CAAA;AACrE,MAAA,MAAM,EAAE,OAAS,EAAA,SAAA,EAAW,MAAM,QAAU,EAAA,MAAA,KAAW,GAAI,CAAA,KAAA,CAAA;AAC3D,MAAM,MAAA,EAAE,KAAO,EAAA,iBAAA,EAAsB,GAAA,QAAA;AAAA,QACnC,OAAA;AAAA,QACA,IAAI,KAAM,CAAA,KAAA;AAAA,QACV,YAAA;AAAA,OACF,CAAA;AAEA,MAAM,MAAA,GAAA,GAAM,IAAIC,WAAO,CAAA;AAAA,QACrB,IAAA,EAAM,kBAAkB,MAAO,CAAA,OAAA;AAAA,QAC/B,KAAA;AAAA,OACD,CAAA,CAAA;AAED,MAAM,MAAA,WAAA,GAAc,MAAM,GAAA,CAAI,mBAAoB,CAAA,GAAA;AAAA,QAChD,SAAA;AAAA,QACA,IAAA;AAAA,QACA,MAAA;AAAA,QACA;AAAA,UACE,QAAA;AAAA,SACF;AAAA,OACF,CAAA;AAEA,MAAA,IAAI,CAAC,WAAA,CAAY,cAAe,CAAA,OAAO,CAAG,EAAA;AACxC,QAAM,MAAA,IAAIF,kBAAW,CAA4C,0CAAA,CAAA,CAAA,CAAA;AAAA,OACnE;AAEA,MAAI,GAAA,CAAA,MAAA,CAAO,cAAgB,EAAA,WAAA,CAAY,KAAe,CAAA,CAAA;AACtD,MAAI,GAAA,CAAA,MAAA,CAAO,MAAQ,EAAA,WAAA,CAAY,QAAQ,CAAA,CAAA;AAAA,KACzC;AAAA,GACD,CAAA,CAAA;AACH;;AC7Fa,MAAA,oCAAA,GAAuC,CAAC,OAE/C,KAAA;AACJ,EAAM,MAAA,EAAE,cAAiB,GAAA,OAAA,CAAA;AACzB,EAAA,OAAOC,yCAOJ,CAAA;AAAA,IACD,EAAI,EAAA,kCAAA;AAAA,IACJ,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,QAAA,EAAU,CAAC,WAAA,EAAa,SAAS,CAAA;AAAA,QACjC,IAAM,EAAA,QAAA;AAAA,QACN,UAAY,EAAA;AAAA,UACV,OAAS,EAAA;AAAA,YACP,KAAO,EAAA,qBAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,UACA,SAAW,EAAA;AAAA,YACT,KAAO,EAAA,YAAA;AAAA,YACP,IAAA,EAAM,CAAC,QAAA,EAAU,QAAQ,CAAA;AAAA,WAC3B;AAAA,UACA,IAAM,EAAA;AAAA,YACJ,KAAO,EAAA,mBAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,UACA,WAAa,EAAA;AAAA,YACX,KAAO,EAAA,2BAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,UACA,MAAQ,EAAA;AAAA,YACN,KAAO,EAAA,QAAA;AAAA,YACP,IAAM,EAAA,OAAA;AAAA,WACR;AAAA,UACA,KAAO,EAAA;AAAA,YACL,KAAO,EAAA,sBAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,YACN,WAAa,EAAA,8CAAA;AAAA,WACf;AAAA,SACF;AAAA,OACF;AAAA,MACA,MAAQ,EAAA;AAAA,QACN,IAAM,EAAA,QAAA;AAAA,QACN,UAAY,EAAA;AAAA,UACV,YAAc,EAAA;AAAA,YACZ,KAAO,EAAA,cAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,SACF;AAAA,OACF;AAAA,KACF;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAA,GAAA,CAAI,MAAO,CAAA,IAAA,CAAK,CAA+B,4BAAA,EAAA,GAAA,CAAI,MAAM,SAAY,CAAA,CAAA,CAAA,CAAA,CAAA;AACrE,MAAA,MAAM,EAAE,OAAS,EAAA,SAAA,EAAW,MAAM,WAAa,EAAA,MAAA,KAAW,GAAI,CAAA,KAAA,CAAA;AAC9D,MAAM,MAAA,EAAE,KAAO,EAAA,iBAAA,EAAsB,GAAA,QAAA;AAAA,QACnC,OAAA;AAAA,QACA,IAAI,KAAM,CAAA,KAAA;AAAA,QACV,YAAA;AAAA,OACF,CAAA;AAEA,MAAA,MAAM,WAAW,MAAM,KAAA;AAAA,QACrB,CAAA,EAAG,iBAAkB,CAAA,MAAA,CAAO,OAA2B,CAAA,iBAAA,EAAA,SAAA,CAAA,cAAA,CAAA;AAAA,QACvD;AAAA,UACE,MAAQ,EAAA,MAAA;AAAA;AAAA,UACR,OAAS,EAAA;AAAA,YACP,eAAiB,EAAA,KAAA;AAAA,YACjB,cAAgB,EAAA,kBAAA;AAAA,WAClB;AAAA,UACA,IAAA,EAAM,KAAK,SAAU,CAAA;AAAA,YACnB,IAAA;AAAA,YACA,MAAA;AAAA,YACA,YAAc,EAAA,WAAA;AAAA,WACf,CAAA;AAAA,SACH;AAAA,OACF,CAAA;AAEA,MAAM,MAAA,MAAA,GAAS,MAAM,QAAA,CAAS,IAAK,EAAA,CAAA;AAEnC,MAAI,GAAA,CAAA,MAAA,CAAO,cAAgB,EAAA,MAAA,CAAO,KAAK,CAAA,CAAA;AAAA,KACzC;AAAA,GACD,CAAA,CAAA;AACH;;ACpFa,MAAA,iCAAA,GAAoC,CAAC,OAE5C,KAAA;AACJ,EAAM,MAAA,EAAE,cAAiB,GAAA,OAAA,CAAA;AACzB,EAAA,OAAOA,yCAWJ,CAAA;AAAA,IACD,EAAI,EAAA,+BAAA;AAAA,IACJ,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,QAAU,EAAA;AAAA,UACR,SAAA;AAAA,UACA,WAAA;AAAA,UACA,KAAA;AAAA,UACA,OAAA;AAAA,UACA,cAAA;AAAA,UACA,mBAAA;AAAA,UACA,QAAA;AAAA,UACA,KAAA;AAAA,UACA,kBAAA;AAAA,SACF;AAAA,QACA,IAAM,EAAA,QAAA;AAAA,QACN,UAAY,EAAA;AAAA,UACV,OAAS,EAAA;AAAA,YACP,KAAO,EAAA,qBAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,UACA,SAAW,EAAA;AAAA,YACT,KAAO,EAAA,YAAA;AAAA,YACP,IAAA,EAAM,CAAC,QAAA,EAAU,QAAQ,CAAA;AAAA,WAC3B;AAAA,UACA,GAAK,EAAA;AAAA,YACH,KACE,EAAA,qGAAA;AAAA,YACF,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,UACA,KAAO,EAAA;AAAA,YACL,KAAO,EAAA,yBAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,UACA,YAAc,EAAA;AAAA,YACZ,KAAO,EAAA,iCAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,UACA,iBAAmB,EAAA;AAAA,YACjB,KAAO,EAAA,mDAAA;AAAA,YACP,IAAM,EAAA,SAAA;AAAA,WACR;AAAA,UACA,MAAQ,EAAA;AAAA,YACN,KAAO,EAAA,gDAAA;AAAA,YACP,IAAM,EAAA,SAAA;AAAA,WACR;AAAA,UACA,GAAK,EAAA;AAAA,YACH,KAAO,EAAA,oDAAA;AAAA,YACP,IAAM,EAAA,SAAA;AAAA,WACR;AAAA,UACA,gBAAkB,EAAA;AAAA,YAChB,KAAO,EAAA,mDAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,UACA,KAAO,EAAA;AAAA,YACL,KAAO,EAAA,sBAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,YACN,WAAa,EAAA,8CAAA;AAAA,WACf;AAAA,SACF;AAAA,OACF;AAAA,KACF;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAM,MAAA;AAAA,QACJ,OAAA;AAAA,QACA,SAAA;AAAA,QACA,GAAA;AAAA,QACA,KAAA;AAAA,QACA,YAAA;AAAA,QACA,iBAAA;AAAA,QACA,MAAA;AAAA,QACA,GAAA;AAAA,QACA,gBAAA;AAAA,UACE,GAAI,CAAA,KAAA,CAAA;AACR,MAAM,MAAA,EAAE,KAAO,EAAA,iBAAA,EAAsB,GAAA,QAAA;AAAA,QACnC,OAAA;AAAA,QACA,IAAI,KAAM,CAAA,KAAA;AAAA,QACV,YAAA;AAAA,OACF,CAAA;AAEA,MAAM,MAAA,GAAA,GAAM,IAAIC,WAAO,CAAA;AAAA,QACrB,IAAA,EAAM,kBAAkB,MAAO,CAAA,OAAA;AAAA,QAC/B,KAAA;AAAA,OACD,CAAA,CAAA;AAED,MAAM,MAAA,GAAA,CAAI,gBAAiB,CAAA,MAAA,CAAO,SAAW,EAAA;AAAA,QAC3C,GAAA;AAAA,QACA,KAAA;AAAA,QACA,aAAe,EAAA,YAAA;AAAA,QACf,SAAW,EAAA,iBAAA;AAAA,QACX,MAAA;AAAA,QACA,GAAA;AAAA,QACA,iBAAmB,EAAA,gBAAA;AAAA,OACpB,CAAA,CAAA;AAAA,KACH;AAAA,GACD,CAAA,CAAA;AACH;;;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,59 @@
+import * as _backstage_plugin_scaffolder_node from '@backstage/plugin-scaffolder-node';
+import { ScmIntegrationRegistry } from '@backstage/integration';
+
+/**
+ * Creates a `gitlab:create-project-deploy-token` Scaffolder action.
+ *
+ * @param options - Templating configuration.
+ * @public
+ */
+declare const createGitlabProjectDeployTokenAction: (options: {
+    integrations: ScmIntegrationRegistry;
+}) => _backstage_plugin_scaffolder_node.TemplateAction<{
+    repoUrl: string;
+    projectId: string | number;
+    name: string;
+    username: string;
+    scopes: string[];
+    token?: string | undefined;
+}>;
+
+/**
+ * Creates a `gitlab:create-project-access-token` Scaffolder action.
+ *
+ * @param options - Templating configuration.
+ * @public
+ */
+declare const createGitlabProjectAccessTokenAction: (options: {
+    integrations: ScmIntegrationRegistry;
+}) => _backstage_plugin_scaffolder_node.TemplateAction<{
+    repoUrl: string;
+    projectId: string | number;
+    name: string;
+    accessLevel: number;
+    scopes: string[];
+    token?: string | undefined;
+}>;
+
+/**
+ * Creates a `gitlab:create-project-variable` Scaffolder action.
+ *
+ * @param options - Templating configuration.
+ * @public
+ */
+declare const createGitlabProjectVariableAction: (options: {
+    integrations: ScmIntegrationRegistry;
+}) => _backstage_plugin_scaffolder_node.TemplateAction<{
+    repoUrl: string;
+    projectId: string | number;
+    key: string;
+    value: string;
+    variableType: string;
+    variableProtected: boolean;
+    masked: boolean;
+    raw: boolean;
+    environmentScope: string;
+    token?: string | undefined;
+}>;
+
+export { createGitlabProjectAccessTokenAction, createGitlabProjectDeployTokenAction, createGitlabProjectVariableAction };

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@backstage/plugin-scaffolder-backend-module-gitlab",
+  "version": "0.1.0-next.0",
+  "main": "dist/index.esm.js",
+  "types": "dist/index.d.ts",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.esm.js",
+    "types": "dist/index.d.ts"
+  },
+  "backstage": {
+    "role": "backend-plugin-module"
+  },
+  "homepage": "https://backstage.io",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/backstage/backstage",
+    "directory": "plugins/scaffolder-backend-module-gitlab"
+  },
+  "keywords": [
+    "backstage"
+  ],
+  "scripts": {
+    "start": "backstage-cli package start",
+    "build": "backstage-cli package build",
+    "lint": "backstage-cli package lint",
+    "test": "backstage-cli package test",
+    "clean": "backstage-cli package clean",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack"
+  },
+  "dependencies": {
+    "@backstage/config": "^1.0.7",
+    "@backstage/errors": "^1.1.5",
+    "@backstage/integration": "^1.4.3",
+    "@backstage/plugin-scaffolder-node": "^0.1.2-next.0",
+    "@gitbeaker/node": "^35.8.0"
+  },
+  "devDependencies": {
+    "@backstage/backend-common": "^0.18.4-next.0",
+    "@backstage/cli": "^0.22.6-next.0",
+    "@backstage/core-app-api": "^1.7.0-next.0"
+  },
+  "files": [
+    "dist"
+  ]
+}