@backstage/plugin-scaffolder-backend 1.0.1-next.0 → 1.1.0

package/CHANGELOG.md

@@ -1,5 +1,48 @@
 # @backstage/plugin-scaffolder-backend
 
+## 1.1.0
+
+### Minor Changes
+
+- 2a7d52ca2c: Override default commit message and author details in GitLab action
+- f5f921dafb: Add new `draft` option to the `publish:github:pull-request` action.
+
+### Patch Changes
+
+- 64d9a031a8: build(deps): bump `isbinaryfile` from 4.0.8 to 5.0.0
+- 2f3d3a1eae: build(deps): bump `@gitbeaker/core` from 34.6.0 to 35.6.0
+- Updated dependencies
+  - @backstage/plugin-catalog-backend@1.1.0
+  - @backstage/integration@1.1.0
+  - @backstage/catalog-model@1.0.1
+  - @backstage/backend-common@0.13.2
+  - @backstage/catalog-client@1.0.1
+  - @backstage/plugin-scaffolder-common@1.0.1
+
+## 1.1.0-next.2
+
+### Patch Changes
+
+- 64d9a031a8: build(deps): bump `isbinaryfile` from 4.0.8 to 5.0.0
+- 2f3d3a1eae: build(deps): bump `@gitbeaker/core` from 34.6.0 to 35.6.0
+- Updated dependencies
+  - @backstage/plugin-catalog-backend@1.1.0-next.2
+  - @backstage/catalog-model@1.0.1-next.1
+
+## 1.1.0-next.1
+
+### Minor Changes
+
+- 2a7d52ca2c: Override default commit message and author details in GitLab action
+- f5f921dafb: Add new `draft` option to the `publish:github:pull-request` action.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/plugin-catalog-backend@1.1.0-next.1
+  - @backstage/integration@1.1.0-next.1
+  - @backstage/backend-common@0.13.2-next.1
+
 ## 1.0.1-next.0
 
 ### Patch Changes

package/README.md

@@ -21,8 +21,7 @@ restoring the plugin, if you previously removed it.
 
 ```bash
 # From your Backstage root directory
-cd packages/backend
-yarn add @backstage/plugin-scaffolder-backend
+yarn add --cwd packages/backend @backstage/plugin-scaffolder-backend
 ```
 
 ### Adding the plugin to your `packages/backend`

package/dist/index.cjs.js

@@ -1528,6 +1528,11 @@ const createPublishGithubPullRequestAction = ({
             title: "Pull Request Description",
             description: "The description of the pull request"
           },
+          draft: {
+            type: "boolean",
+            title: "Create as Draft",
+            description: "Create a draft pull request"
+          },
           sourcePath: {
             type: "string",
             title: "Working Subdirectory",
@@ -1568,6 +1573,7 @@ const createPublishGithubPullRequestAction = ({
         branchName,
         title,
         description,
+        draft,
         targetPath,
         sourcePath,
         token: providedToken
@@ -1618,7 +1624,8 @@ const createPublishGithubPullRequestAction = ({
           title,
           changes,
           body: description,
-          head: branchName
+          head: branchName,
+          draft
         });
         if (!response) {
           throw new GithubResponseError("null response from Github");
@@ -1656,6 +1663,21 @@ function createPublishGitlabAction(options) {
             type: "string",
             description: `Sets the default branch on the repository. The default value is 'master'`
           },
+          gitCommitMessage: {
+            title: "Git Commit Message",
+            type: "string",
+            description: `Sets the commit message on the repository. The default value is 'initial commit'`
+          },
+          gitAuthorName: {
+            title: "Default Author Name",
+            type: "string",
+            description: `Sets the default author name for the commit. The default value is 'Scaffolder'`
+          },
+          gitAuthorEmail: {
+            title: "Default Author Email",
+            type: "string",
+            description: `Sets the default author email for the commit.`
+          },
           sourcePath: {
             title: "Source Path",
             description: "Path within the workspace that will be used as the repository root. If omitted, the entire workspace will be published as the repository.",
@@ -1686,7 +1708,10 @@ function createPublishGitlabAction(options) {
       const {
         repoUrl,
         repoVisibility = "private",
-        defaultBranch = "master"
+        defaultBranch = "master",
+        gitCommitMessage = "initial commit",
+        gitAuthorName,
+        gitAuthorEmail
       } = ctx.input;
       const { owner, repo, host } = parseRepoUrl(repoUrl, integrations);
       if (!owner) {
@@ -1718,8 +1743,8 @@ function createPublishGitlabAction(options) {
       const remoteUrl = http_url_to_repo.replace(/\.git$/, "");
       const repoContentsUrl = `${remoteUrl}/-/blob/${defaultBranch}`;
       const gitAuthorInfo = {
-        name: config.getOptionalString("scaffolder.defaultAuthor.name"),
-        email: config.getOptionalString("scaffolder.defaultAuthor.email")
+        name: gitAuthorName ? gitAuthorName : config.getOptionalString("scaffolder.defaultAuthor.name"),
+        email: gitAuthorEmail ? gitAuthorEmail : config.getOptionalString("scaffolder.defaultAuthor.email")
       };
       await initRepoAndPush({
         dir: getRepoSourceDirectory(ctx.workspacePath, ctx.input.sourcePath),
@@ -1730,7 +1755,7 @@ function createPublishGitlabAction(options) {
           password: token
         },
         logger: ctx.logger,
-        commitMessage: config.getOptionalString("scaffolder.defaultCommitMessage"),
+        commitMessage: gitCommitMessage ? gitCommitMessage : config.getOptionalString("scaffolder.defaultCommitMessage"),
         gitAuthorInfo
       });
       ctx.output("remoteUrl", remoteUrl);