@backstage/plugin-scaffolder-backend 0.18.0 → 1.1.0-next.1

package/CHANGELOG.md

@@ -1,5 +1,54 @@
 # @backstage/plugin-scaffolder-backend
 
+## 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
+
+- Updated dependencies
+  - @backstage/catalog-model@1.0.1-next.0
+  - @backstage/plugin-catalog-backend@1.0.1-next.0
+  - @backstage/backend-common@0.13.2-next.0
+  - @backstage/integration@1.0.1-next.0
+  - @backstage/catalog-client@1.0.1-next.0
+  - @backstage/plugin-scaffolder-common@1.0.1-next.0
+
+## 1.0.0
+
+### Major Changes
+
+- b58c70c223: This package has been promoted to v1.0! To understand how this change affects the package, please check out our [versioning policy](https://backstage.io/docs/overview/versioning-policy).
+
+### Patch Changes
+
+- 765639f98c: Added new `github:issues:label` action to apply labels to issues, and also output `pullRequestNumber` from `publish:github:pull-request`.
+- efc73db10c: Use `better-sqlite3` instead of `@vscode/sqlite3`
+- c8475ab3bb: Adding some documentation for exported things
+- f24ef7864e: Minor typo fixes
+- Updated dependencies
+  - @backstage/plugin-catalog-backend@1.0.0
+  - @backstage/backend-common@0.13.1
+  - @backstage/catalog-model@1.0.0
+  - @backstage/plugin-scaffolder-common@1.0.0
+  - @backstage/integration@1.0.0
+  - @backstage/catalog-client@1.0.0
+  - @backstage/config@1.0.0
+  - @backstage/errors@1.0.0
+  - @backstage/types@1.0.0
+
 ## 0.18.0
 
 ### Minor Changes

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",
@@ -1553,6 +1558,11 @@ const createPublishGithubPullRequestAction = ({
             type: "string",
             title: "Pull Request URL",
             description: "Link to the pull request in Github"
+          },
+          pullRequestNumber: {
+            type: "number",
+            title: "Pull Request Number",
+            description: "The pull request number"
           }
         }
       }
@@ -1563,6 +1573,7 @@ const createPublishGithubPullRequestAction = ({
         branchName,
         title,
         description,
+        draft,
         targetPath,
         sourcePath,
         token: providedToken
@@ -1613,12 +1624,14 @@ const createPublishGithubPullRequestAction = ({
           title,
           changes,
           body: description,
-          head: branchName
+          head: branchName,
+          draft
         });
         if (!response) {
           throw new GithubResponseError("null response from Github");
         }
         ctx.output("remoteUrl", response.data.html_url);
+        ctx.output("pullRequestNumber", response.data.number);
       } catch (e) {
         throw new GithubResponseError("Pull request creation failed", e);
       }
@@ -1650,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.",
@@ -1680,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) {
@@ -1712,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),
@@ -1724,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);
@@ -2038,6 +2069,70 @@ function createGithubWebhookAction(options) {
   });
 }
 
+function createGithubIssuesLabelAction(options) {
+  const { integrations, githubCredentialsProvider } = options;
+  return createTemplateAction({
+    id: "github:issues:label",
+    description: "Adds labels to a pull request or issue on GitHub.",
+    schema: {
+      input: {
+        type: "object",
+        required: ["repoUrl", "number", "labels"],
+        properties: {
+          repoUrl: {
+            title: "Repository Location",
+            description: `Accepts the format 'github.com?repo=reponame&owner=owner' where 'reponame' is the repository name and 'owner' is an organization or username`,
+            type: "string"
+          },
+          number: {
+            title: "Pull Request or issue number",
+            description: "The pull request or issue number to add labels to",
+            type: "number"
+          },
+          labels: {
+            title: "Labels",
+            description: "The labels to add to the pull request or issue",
+            type: "array",
+            items: {
+              type: "string"
+            }
+          },
+          token: {
+            title: "Authentication Token",
+            type: "string",
+            description: "The GITHUB_TOKEN to use for authorization to GitHub"
+          }
+        }
+      }
+    },
+    async handler(ctx) {
+      const { repoUrl, number, labels, token: providedToken } = ctx.input;
+      const { owner, repo } = parseRepoUrl(repoUrl, integrations);
+      ctx.logger.info(`Adding labels to ${number} issue on repo ${repo}`);
+      if (!owner) {
+        throw new errors.InputError("Invalid repository owner provided in repoUrl");
+      }
+      const client = new octokit.Octokit(await getOctokitOptions({
+        integrations,
+        credentialsProvider: githubCredentialsProvider,
+        repoUrl,
+        token: providedToken
+      }));
+      try {
+        await client.rest.issues.addLabels({
+          owner,
+          repo,
+          issue_number: number,
+          labels
+        });
+      } catch (e) {
+        errors.assertError(e);
+        ctx.logger.warn(`Failed: adding labels to issue: '${number}' on repo: '${repo}', ${e.message}`);
+      }
+    }
+  });
+}
+
 const createBuiltinActions = (options) => {
   const {
     reader,
@@ -2093,6 +2188,10 @@ const createBuiltinActions = (options) => {
     createGithubWebhookAction({
       integrations,
       githubCredentialsProvider
+    }),
+    createGithubIssuesLabelAction({
+      integrations,
+      githubCredentialsProvider
     })
   ];
   return actions;
@@ -2950,6 +3049,7 @@ exports.createFetchTemplateAction = createFetchTemplateAction;
 exports.createFilesystemDeleteAction = createFilesystemDeleteAction;
 exports.createFilesystemRenameAction = createFilesystemRenameAction;
 exports.createGithubActionsDispatchAction = createGithubActionsDispatchAction;
+exports.createGithubIssuesLabelAction = createGithubIssuesLabelAction;
 exports.createGithubWebhookAction = createGithubWebhookAction;
 exports.createPublishAzureAction = createPublishAzureAction;
 exports.createPublishBitbucketAction = createPublishBitbucketAction;