@backstage/plugin-scaffolder-backend 1.18.0-next.1 → 1.18.0

package/dist/cjs/{router-2e0adf31.cjs.js → router-d7df4c2b.cjs.js}

@@ -80,7 +80,7 @@ var winston__namespace = /*#__PURE__*/_interopNamespace(winston);
 var nunjucks__default = /*#__PURE__*/_interopDefaultLegacy(nunjucks);
 var os__default = /*#__PURE__*/_interopDefaultLegacy(os);
 
-const examples$f = [
+const examples$h = [
   {
     description: "Register with the catalog",
     example: yaml__default["default"].stringify({
@@ -104,7 +104,7 @@ function createCatalogRegisterAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: id$4,
     description: "Registers entities from a catalog descriptor file in the workspace into the software catalog.",
-    examples: examples$f,
+    examples: examples$h,
     schema: {
       input: {
         oneOf: [
@@ -228,7 +228,7 @@ function createCatalogRegisterAction(options) {
   });
 }
 
-const examples$e = [
+const examples$g = [
   {
     description: "Write a catalog yaml file",
     example: yaml__namespace.stringify({
@@ -272,7 +272,7 @@ function createCatalogWriteAction() {
         )
       })
     },
-    examples: examples$e,
+    examples: examples$g,
     supportsDryRun: true,
     async handler(ctx) {
       ctx.logStream.write(`Writing catalog-info.yaml`);
@@ -286,7 +286,7 @@ function createCatalogWriteAction() {
   });
 }
 
-const examples$d = [
+const examples$f = [
   {
     description: "Fetch entity by reference",
     example: yaml__default["default"].stringify({
@@ -325,7 +325,7 @@ function createFetchCatalogEntityAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: id$2,
     description: "Returns entity or entities from the catalog by entity reference(s)",
-    examples: examples$d,
+    examples: examples$f,
     supportsDryRun: true,
     schema: {
       input: zod.z.object({
@@ -400,7 +400,7 @@ function createFetchCatalogEntityAction(options) {
   });
 }
 
-const examples$c = [
+const examples$e = [
   {
     description: "Write a debug message",
     example: yaml__default["default"].stringify({
@@ -438,7 +438,7 @@ function createDebugLogAction() {
   return pluginScaffolderNode.createTemplateAction({
     id: id$1,
     description: "Writes a message into the log or lists all files in the workspace.",
-    examples: examples$c,
+    examples: examples$e,
     schema: {
       input: {
         type: "object",
@@ -485,7 +485,7 @@ async function recursiveReadDir(dir) {
   return files.reduce((a, f) => a.concat(f), []);
 }
 
-const examples$b = [
+const examples$d = [
   {
     description: "Waiting for 50 milliseconds",
     example: yaml__default["default"].stringify({
@@ -548,7 +548,7 @@ function createWaitAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id,
     description: "Waits for a certain period of time.",
-    examples: examples$b,
+    examples: examples$d,
     schema: {
       input: {
         type: "object",
@@ -593,7 +593,7 @@ function createWaitAction(options) {
   });
 }
 
-const examples$a = [
+const examples$c = [
   {
     description: "Downloads content and places it in the workspace.",
     example: yaml__default["default"].stringify({
@@ -632,7 +632,7 @@ function createFetchPlainAction(options) {
   const { reader, integrations } = options;
   return pluginScaffolderNode.createTemplateAction({
     id: ACTION_ID,
-    examples: examples$a,
+    examples: examples$c,
     description: "Downloads content and places it in the workspace, or optionally in a subdirectory specified by the `targetPath` input option.",
     schema: {
       input: {
@@ -669,7 +669,7 @@ function createFetchPlainAction(options) {
   });
 }
 
-const examples$9 = [
+const examples$b = [
   {
     description: "Downloads a file and places it in the workspace.",
     example: yaml__default["default"].stringify({
@@ -693,7 +693,7 @@ function createFetchPlainFileAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: "fetch:plain:file",
     description: "Downloads single file and places it in the workspace.",
-    examples: examples$9,
+    examples: examples$b,
     schema: {
       input: {
         type: "object",
@@ -961,7 +961,7 @@ const createDefaultFilters = ({
   };
 };
 
-const examples$8 = [
+const examples$a = [
   {
     description: "Downloads a skelaton directory that lives alongside the template file and fill it out with values.",
     example: yaml__default["default"].stringify({
@@ -997,7 +997,7 @@ function createFetchTemplateAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: "fetch:template",
     description: "Downloads a skeleton, templates variables into file and directory names and content, and places the result in the workspace, or optionally in a subdirectory specified by the `targetPath` input option.",
-    examples: examples$8,
+    examples: examples$a,
     schema: {
       input: {
         type: "object",
@@ -1202,7 +1202,7 @@ function containsSkippedContent(localOutputPath) {
   return localOutputPath === "" || localOutputPath.startsWith("/") || localOutputPath.includes("//");
 }
 
-const examples$7 = [
+const examples$9 = [
   {
     description: "Delete specified files",
     example: yaml__namespace.stringify({
@@ -1224,7 +1224,7 @@ const createFilesystemDeleteAction = () => {
   return pluginScaffolderNode.createTemplateAction({
     id: "fs:delete",
     description: "Deletes files and directories from the workspace",
-    examples: examples$7,
+    examples: examples$9,
     schema: {
       input: {
         required: ["files"],
@@ -1261,7 +1261,7 @@ const createFilesystemDeleteAction = () => {
   });
 };
 
-const examples$6 = [
+const examples$8 = [
   {
     description: "Rename specified files ",
     example: yaml__namespace.stringify({
@@ -1287,7 +1287,7 @@ const createFilesystemRenameAction = () => {
   return pluginScaffolderNode.createTemplateAction({
     id: "fs:rename",
     description: "Renames files and directories within the workspace",
-    examples: examples$6,
+    examples: examples$8,
     schema: {
       input: {
         required: ["files"],
@@ -1769,7 +1769,7 @@ async function validateAccessTeam(client, access) {
   }
 }
 
-const examples$5 = [
+const examples$7 = [
   {
     description: "GitHub Action Workflow Without Inputs.",
     example: yaml__default["default"].stringify({
@@ -1830,7 +1830,7 @@ function createGithubActionsDispatchAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: "github:actions:dispatch",
     description: "Dispatches a GitHub Action workflow for a given branch or tag",
-    examples: examples$5,
+    examples: examples$7,
     schema: {
       input: {
         type: "object",
@@ -1899,11 +1899,48 @@ function createGithubActionsDispatchAction(options) {
   });
 }
 
+const examples$6 = [
+  {
+    description: "Add labels to pull request or issue",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: "github:issues:label",
+          name: "Add labels to pull request or issue",
+          input: {
+            repoUrl: "github.com?repo=repo&owner=owner",
+            number: "1",
+            labels: ["bug"]
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Add labels to pull request or issue with specific token",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: "github:issues:label",
+          name: "Add labels to pull request or issue with token",
+          input: {
+            repoUrl: "github.com?repo=repo&owner=owner",
+            number: "1",
+            labels: ["bug", "documentation"],
+            token: "gph_YourGitHubToken"
+          }
+        }
+      ]
+    })
+  }
+];
+
 function createGithubIssuesLabelAction(options) {
   const { integrations, githubCredentialsProvider } = options;
   return pluginScaffolderNode.createTemplateAction({
     id: "github:issues:label",
     description: "Adds labels to a pull request or issue on GitHub.",
+    examples: examples$6,
     schema: {
       input: {
         type: "object",
@@ -2226,7 +2263,7 @@ const commitHash = {
   type: "string"
 };
 
-const examples$4 = [
+const examples$5 = [
   {
     description: "Creates a GitHub repository with default configuration.",
     example: yaml__default["default"].stringify({
@@ -2279,7 +2316,7 @@ function createGithubRepoCreateAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: "github:repo:create",
     description: "Creates a GitHub repository.",
-    examples: examples$4,
+    examples: examples$5,
     schema: {
       input: {
         type: "object",
@@ -2386,7 +2423,7 @@ function createGithubRepoCreateAction(options) {
   });
 }
 
-const examples$3 = [
+const examples$4 = [
   {
     description: "Setup repo with no modifications to branch protection rules",
     example: yaml__default["default"].stringify({
@@ -2438,7 +2475,7 @@ function createGithubRepoPushAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: "github:repo:push",
     description: "Initializes a git repository of contents in workspace and publishes it to GitHub.",
-    examples: examples$3,
+    examples: examples$4,
     schema: {
       input: {
         type: "object",
@@ -2912,10 +2949,62 @@ function createGithubEnvironmentAction(options) {
   });
 }
 
+const examples$3 = [
+  {
+    description: "Initializes a git repository of the content in the workspace, and publishes it to Azure.",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          id: "publish",
+          action: "publish:azure",
+          name: "Publish to Azure",
+          input: {
+            repoUrl: "dev.azure.com?organization=organization&owner=project&repo=repo"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Add a description.",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          id: "publish",
+          action: "publish:azure",
+          name: "Publish to Azure",
+          input: {
+            repoUrl: "dev.azure.com?organization=organization&owner=project&repo=repo",
+            description: "Initialize a git repository"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Change the default branch.",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          id: "publish",
+          action: "publish:azure",
+          name: "Publish to Azure",
+          input: {
+            repoUrl: "dev.azure.com?organization=organization&owner=project&repo=repo",
+            description: "Initialize a git repository",
+            defaultBranch: "main"
+          }
+        }
+      ]
+    })
+  }
+];
+
 function createPublishAzureAction(options) {
   const { integrations, config } = options;
   return pluginScaffolderNode.createTemplateAction({
     id: "publish:azure",
+    examples: examples$3,
     description: "Initializes a git repository of the content in the workspace, and publishes it to Azure.",
     schema: {
       input: {
@@ -4973,6 +5062,81 @@ const examples = [
         }
       ]
     })
+  },
+  {
+    description: "Initializes a git repository with additional settings.",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          id: "publish",
+          action: "publish:gitlab",
+          name: "Publish to GitLab",
+          input: {
+            repoUrl: "gitlab.com?repo=project_name&owner=group_name",
+            settings: {
+              ci_config_path: ".gitlab-ci.yml",
+              visibility: "public"
+            }
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Initializes a git repository with branches settings",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          id: "publish",
+          action: "publish:gitlab",
+          name: "Publish to GitLab",
+          input: {
+            repoUrl: "gitlab.com?repo=project_name&owner=group_name",
+            branches: [
+              {
+                name: "dev",
+                create: true,
+                protected: true,
+                ref: "master"
+              },
+              {
+                name: "master",
+                protected: true
+              }
+            ]
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Initializes a git repository with environment variables",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          id: "publish",
+          action: "publish:gitlab",
+          name: "Publish to GitLab",
+          input: {
+            repoUrl: "gitlab.com?repo=project_name&owner=group_name",
+            projectVariables: [
+              {
+                key: "key1",
+                value: "value1",
+                protected: true,
+                masked: false
+              },
+              {
+                key: "key2",
+                value: "value2",
+                protected: true,
+                masked: false
+              }
+            ]
+          }
+        }
+      ]
+    })
   }
 ];
 
@@ -4994,6 +5158,7 @@ function createPublishGitlabAction(options) {
           },
           repoVisibility: {
             title: "Repository Visibility",
+            description: `Sets the visibility of the repository. The default value is 'private'. (deprecated, use settings.visibility instead)`,
             type: "string",
             enum: ["private", "public", "internal"]
           },
@@ -5034,11 +5199,128 @@ function createPublishGitlabAction(options) {
           },
           topics: {
             title: "Topic labels",
-            description: "Topic labels to apply on the repository.",
+            description: "Topic labels to apply on the repository. (deprecated, use settings.topics instead)",
             type: "array",
             items: {
               type: "string"
             }
+          },
+          settings: {
+            title: "Project settings",
+            description: "Additional project settings, based on https://docs.gitlab.com/ee/api/projects.html#create-project attributes",
+            type: "object",
+            properties: {
+              path: {
+                title: "Project path",
+                description: "Repository name for new project. Generated based on name if not provided (generated as lowercase with dashes).",
+                type: "string"
+              },
+              auto_devops_enabled: {
+                title: "Auto DevOps enabled",
+                description: "Enable Auto DevOps for this project",
+                type: "boolean"
+              },
+              ci_config_path: {
+                title: "CI config path",
+                description: "Custom CI config path for this project",
+                type: "string"
+              },
+              description: {
+                title: "Project description",
+                description: "Short project description",
+                type: "string"
+              },
+              topics: {
+                title: "Topic labels",
+                description: "Topic labels to apply on the repository",
+                type: "array",
+                items: {
+                  type: "string"
+                }
+              },
+              visibility: {
+                title: "Project visibility",
+                description: "The visibility of the project. Can be private, internal, or public. The default value is private.",
+                type: "string",
+                enum: ["private", "public", "internal"]
+              }
+            }
+          },
+          branches: {
+            title: "Project branches settings",
+            type: "array",
+            items: {
+              type: "object",
+              required: ["name"],
+              properties: {
+                name: {
+                  title: "Branch name",
+                  type: "string"
+                },
+                protect: {
+                  title: "Should branch be protected",
+                  description: `Will mark branch as protected. The default value is 'false'`,
+                  type: "boolean"
+                },
+                create: {
+                  title: "Should branch be created",
+                  description: `If branch does not exist, it will be created from provided ref. The default value is 'false'`,
+                  type: "boolean"
+                },
+                ref: {
+                  title: "Branch reference",
+                  description: `Branch reference to create branch from. The default value is 'master'`,
+                  type: "string"
+                }
+              }
+            }
+          },
+          projectVariables: {
+            title: "Project variables",
+            description: "Project variables settings based on Gitlab Project Environments API - https://docs.gitlab.com/ee/api/project_level_variables.html#create-a-variable",
+            type: "array",
+            items: {
+              type: "object",
+              required: ["key", "value"],
+              properties: {
+                key: {
+                  title: "Variable key",
+                  description: "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: "Variable value",
+                  description: "The value of a variable",
+                  type: "string"
+                },
+                description: {
+                  title: "Variable description",
+                  description: `The description of the variable. The default value is 'null'`,
+                  type: "string"
+                },
+                variable_type: {
+                  title: "Variable type",
+                  description: `The type of a variable. The default value is 'env_var'`,
+                  type: "string",
+                  enum: ["env_var", "file"]
+                },
+                protected: {
+                  title: "Variable protection",
+                  description: `Whether the variable is protected. The default value is 'false'`,
+                  type: "boolean"
+                },
+                raw: {
+                  title: "Variable raw",
+                  description: `Whether the variable is in raw format. The default value is 'false'`,
+                  type: "boolean"
+                },
+                environment_scope: {
+                  title: "Variable environment scope",
+                  description: `The environment_scope of the variable. The default value is '*'`,
+                  type: "string"
+                }
+              }
+            }
           }
         }
       },
@@ -5065,6 +5347,7 @@ function createPublishGitlabAction(options) {
       }
     },
     async handler(ctx) {
+      var _a, _b, _c, _d, _e;
       const {
         repoUrl,
         repoVisibility = "private",
@@ -5073,7 +5356,10 @@ function createPublishGitlabAction(options) {
         gitAuthorName,
         gitAuthorEmail,
         setUserAsOwner = false,
-        topics = []
+        topics = [],
+        settings = {},
+        branches = [],
+        projectVariables = []
       } = ctx.input;
       const { owner, repo, host } = parseRepoUrl(repoUrl, integrations);
       if (!owner) {
@@ -5116,7 +5402,8 @@ function createPublishGitlabAction(options) {
         namespace_id: targetNamespaceId,
         name: repo,
         visibility: repoVisibility,
-        ...topics.length ? { topics } : {}
+        ...topics.length ? { topics } : {},
+        ...Object.keys(settings).length ? { ...settings } : {}
       });
       if (setUserAsOwner && integrationConfig.config.token) {
         const adminClient = new node.Gitlab({
@@ -5143,6 +5430,59 @@ function createPublishGitlabAction(options) {
         commitMessage: gitCommitMessage ? gitCommitMessage : config.getOptionalString("scaffolder.defaultCommitMessage"),
         gitAuthorInfo
       });
+      if (branches) {
+        for (const branch of branches) {
+          const {
+            name,
+            protect = false,
+            create = false,
+            ref = "master"
+          } = branch;
+          if (create) {
+            try {
+              await client.Branches.create(projectId, name, ref);
+            } catch (e) {
+              throw new errors.InputError(
+                `Branch creation failed for ${name}. ${printGitlabError(e)}`
+              );
+            }
+            ctx.logger.info(
+              `Branch ${name} created for ${projectId} with ref ${ref}`
+            );
+          }
+          if (protect) {
+            try {
+              await client.ProtectedBranches.protect(projectId, name);
+            } catch (e) {
+              throw new errors.InputError(
+                `Branch protection failed for ${name}. ${printGitlabError(e)}`
+              );
+            }
+            ctx.logger.info(`Branch ${name} protected for ${projectId}`);
+          }
+        }
+      }
+      if (projectVariables) {
+        for (const variable of projectVariables) {
+          const variableWithDefaults = Object.assign(variable, {
+            variable_type: (_a = variable.variable_type) != null ? _a : "env_var",
+            protected: (_b = variable.protected) != null ? _b : false,
+            masked: (_c = variable.masked) != null ? _c : false,
+            raw: (_d = variable.raw) != null ? _d : false,
+            environment_scope: (_e = variable.environment_scope) != null ? _e : "*"
+          });
+          try {
+            await client.ProjectVariables.create(
+              projectId,
+              variableWithDefaults
+            );
+          } catch (e) {
+            throw new errors.InputError(
+              `Environment variable creation failed for ${variableWithDefaults.key}. ${printGitlabError(e)}`
+            );
+          }
+        }
+      }
       ctx.output("commitHash", commitResult == null ? void 0 : commitResult.commitHash);
       ctx.output("remoteUrl", remoteUrl);
       ctx.output("repoContentsUrl", repoContentsUrl);
@@ -5150,6 +5490,9 @@ function createPublishGitlabAction(options) {
     }
   });
 }
+function printGitlabError(error) {
+  return JSON.stringify({ code: error.code, message: error.description });
+}
 
 const createPublishGitlabMergeRequestAction = (options) => {
   const { integrations } = options;
@@ -7287,4 +7630,4 @@ exports.createRouter = createRouter;
 exports.createWaitAction = createWaitAction;
 exports.scaffolderActionRules = scaffolderActionRules;
 exports.scaffolderTemplateRules = scaffolderTemplateRules;
-//# sourceMappingURL=router-2e0adf31.cjs.js.map
+//# sourceMappingURL=router-d7df4c2b.cjs.js.map