@backstage/plugin-scaffolder-backend 1.16.4 → 1.16.6-next.1

package/CHANGELOG.md

@@ -1,63 +1,55 @@
 # @backstage/plugin-scaffolder-backend
 
-## 1.16.4
-
-### Patch Changes
-
-- Updated dependencies
-  - @backstage/plugin-catalog-backend@1.12.3
-
-## 1.16.3
-
-### Patch Changes
-
-- Updated dependencies
-  - @backstage/plugin-catalog-backend@1.12.2
-  - @backstage/integration@1.6.2
-  - @backstage/backend-common@0.19.4
-  - @backstage/plugin-scaffolder-node@0.2.2
-  - @backstage/backend-tasks@0.5.7
-  - @backstage/plugin-auth-node@0.2.19
-  - @backstage/plugin-catalog-node@1.4.3
-  - @backstage/plugin-permission-node@0.7.13
-  - @backstage/backend-plugin-api@0.6.2
-  - @backstage/catalog-client@1.4.3
-  - @backstage/catalog-model@1.4.1
-  - @backstage/config@1.0.8
+## 1.16.6-next.1
+
+### Patch Changes
+
+- f3c0b95e3ef1: Add examples for `github:actions:dispatch` scaffolder actions.
+- Updated dependencies
+  - @backstage/plugin-catalog-backend@1.13.0-next.1
+  - @backstage/config@1.1.0-next.0
+  - @backstage/integration@1.7.0-next.1
+  - @backstage/backend-tasks@0.5.8-next.1
+  - @backstage/backend-common@0.19.5-next.1
+  - @backstage/backend-plugin-api@0.6.3-next.1
+  - @backstage/catalog-model@1.4.2-next.0
+  - @backstage/plugin-auth-node@0.3.0-next.1
+  - @backstage/plugin-permission-common@0.7.8-next.0
+  - @backstage/plugin-permission-node@0.7.14-next.1
+  - @backstage/plugin-scaffolder-node@0.2.3-next.1
+  - @backstage/plugin-catalog-node@1.4.4-next.1
+  - @backstage/catalog-client@1.4.4-next.0
+  - @backstage/plugin-catalog-common@1.0.16-next.0
+  - @backstage/plugin-scaffolder-common@1.4.1-next.0
   - @backstage/errors@1.2.1
   - @backstage/types@1.1.0
-  - @backstage/plugin-catalog-common@1.0.15
-  - @backstage/plugin-permission-common@0.7.7
-  - @backstage/plugin-scaffolder-common@1.4.0
 
-## 1.16.2
+## 1.16.3-next.0
 
 ### Patch Changes
 
+- a4989552d828: Add examples for `publish:github` and `publish:gitlab` scaffolder actions.
+- 5f1a92b9f19f: Use `DefaultAzureDevOpsCredentialsProvider` to retrieve credentials for Azure DevOps.
+- fb57a4694fc6: Fixed the plugin and module ID of the alpha `catalogModuleTemplateKind` export.
+- cfc3ca6ce060: Changes needed to support MySQL
 - Updated dependencies
-  - @backstage/integration@1.6.1
-  - @backstage/plugin-catalog-backend@1.12.1
-  - @backstage/backend-common@0.19.3
-  - @backstage/plugin-scaffolder-node@0.2.1
-  - @backstage/backend-tasks@0.5.6
-  - @backstage/plugin-auth-node@0.2.18
-  - @backstage/plugin-catalog-node@1.4.2
-  - @backstage/plugin-permission-node@0.7.12
-  - @backstage/backend-plugin-api@0.6.1
+  - @backstage/plugin-catalog-backend@1.12.2-next.0
+  - @backstage/plugin-auth-node@0.3.0-next.0
+  - @backstage/backend-common@0.19.4-next.0
+  - @backstage/integration@1.7.0-next.0
+  - @backstage/backend-tasks@0.5.7-next.0
+  - @backstage/backend-plugin-api@0.6.2-next.0
   - @backstage/catalog-client@1.4.3
   - @backstage/catalog-model@1.4.1
   - @backstage/config@1.0.8
   - @backstage/errors@1.2.1
   - @backstage/types@1.1.0
   - @backstage/plugin-catalog-common@1.0.15
+  - @backstage/plugin-catalog-node@1.4.3-next.0
   - @backstage/plugin-permission-common@0.7.7
+  - @backstage/plugin-permission-node@0.7.13-next.0
   - @backstage/plugin-scaffolder-common@1.4.0
-
-## 1.16.1
-
-### Patch Changes
-
-- 2ba07bcdb046: Fixed the plugin and module ID of the alpha `catalogModuleTemplateKind` export.
+  - @backstage/plugin-scaffolder-node@0.2.2-next.0
 
 ## 1.16.0
 

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-scaffolder-backend",
-  "version": "1.16.4",
+  "version": "1.16.6-next.1",
   "main": "../dist/alpha.cjs.js",
   "types": "../dist/alpha.d.ts"
 }

package/dist/alpha.cjs.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var backendPluginApi = require('@backstage/backend-plugin-api');
 var alpha = require('@backstage/plugin-catalog-node/alpha');
-var ScaffolderEntitiesProcessor = require('./cjs/ScaffolderEntitiesProcessor-4b7489dd.cjs.js');
+var ScaffolderEntitiesProcessor = require('./cjs/ScaffolderEntitiesProcessor-96675669.cjs.js');
 var alpha$1 = require('@backstage/plugin-scaffolder-common/alpha');
 var pluginPermissionNode = require('@backstage/plugin-permission-node');
 var backendCommon = require('@backstage/backend-common');

package/dist/cjs/{ScaffolderEntitiesProcessor-4b7489dd.cjs.js → ScaffolderEntitiesProcessor-96675669.cjs.js}

@@ -81,7 +81,7 @@ var winston__namespace = /*#__PURE__*/_interopNamespace(winston);
 var nunjucks__default = /*#__PURE__*/_interopDefaultLegacy(nunjucks);
 var os__default = /*#__PURE__*/_interopDefaultLegacy(os);
 
-const examples$b = [
+const examples$e = [
   {
     description: "Register with the catalog",
     example: yaml__default["default"].stringify({
@@ -105,7 +105,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$b,
+    examples: examples$e,
     schema: {
       input: {
         oneOf: [
@@ -229,7 +229,7 @@ function createCatalogRegisterAction(options) {
   });
 }
 
-const examples$a = [
+const examples$d = [
   {
     description: "Write a catalog yaml file",
     example: yaml__namespace.stringify({
@@ -273,7 +273,7 @@ function createCatalogWriteAction() {
         )
       })
     },
-    examples: examples$a,
+    examples: examples$d,
     supportsDryRun: true,
     async handler(ctx) {
       ctx.logStream.write(`Writing catalog-info.yaml`);
@@ -287,7 +287,7 @@ function createCatalogWriteAction() {
   });
 }
 
-const examples$9 = [
+const examples$c = [
   {
     description: "Fetch entity by reference",
     example: yaml__default["default"].stringify({
@@ -326,7 +326,7 @@ function createFetchCatalogEntityAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: id$2,
     description: "Returns entity or entities from the catalog by entity reference(s)",
-    examples: examples$9,
+    examples: examples$c,
     supportsDryRun: true,
     schema: {
       input: zod.z.object({
@@ -401,7 +401,7 @@ function createFetchCatalogEntityAction(options) {
   });
 }
 
-const examples$8 = [
+const examples$b = [
   {
     description: "Write a debug message",
     example: yaml__default["default"].stringify({
@@ -439,7 +439,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$8,
+    examples: examples$b,
     schema: {
       input: {
         type: "object",
@@ -486,7 +486,7 @@ async function recursiveReadDir(dir) {
   return files.reduce((a, f) => a.concat(f), []);
 }
 
-const examples$7 = [
+const examples$a = [
   {
     description: "Waiting for 50 milliseconds",
     example: yaml__default["default"].stringify({
@@ -549,7 +549,7 @@ function createWaitAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id,
     description: "Waits for a certain period of time.",
-    examples: examples$7,
+    examples: examples$a,
     schema: {
       input: {
         type: "object",
@@ -594,7 +594,7 @@ function createWaitAction(options) {
   });
 }
 
-const examples$6 = [
+const examples$9 = [
   {
     description: "Downloads content and places it in the workspace.",
     example: yaml__default["default"].stringify({
@@ -633,7 +633,7 @@ function createFetchPlainAction(options) {
   const { reader, integrations } = options;
   return pluginScaffolderNode.createTemplateAction({
     id: ACTION_ID,
-    examples: examples$6,
+    examples: examples$9,
     description: "Downloads content and places it in the workspace, or optionally in a subdirectory specified by the `targetPath` input option.",
     schema: {
       input: {
@@ -670,7 +670,7 @@ function createFetchPlainAction(options) {
   });
 }
 
-const examples$5 = [
+const examples$8 = [
   {
     description: "Downloads a file and places it in the workspace.",
     example: yaml__default["default"].stringify({
@@ -694,7 +694,7 @@ function createFetchPlainFileAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: "fetch:plain:file",
     description: "Downloads single file and places it in the workspace.",
-    examples: examples$5,
+    examples: examples$8,
     schema: {
       input: {
         type: "object",
@@ -962,7 +962,7 @@ const createDefaultFilters = ({
   };
 };
 
-const examples$4 = [
+const examples$7 = [
   {
     description: "Downloads a skelaton directory that lives alongside the template file and fill it out with values.",
     example: yaml__default["default"].stringify({
@@ -998,7 +998,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$4,
+    examples: examples$7,
     schema: {
       input: {
         type: "object",
@@ -1203,7 +1203,7 @@ function containsSkippedContent(localOutputPath) {
   return localOutputPath === "" || localOutputPath.startsWith("/") || localOutputPath.includes("//");
 }
 
-const examples$3 = [
+const examples$6 = [
   {
     description: "Delete specified files",
     example: yaml__namespace.stringify({
@@ -1225,7 +1225,7 @@ const createFilesystemDeleteAction = () => {
   return pluginScaffolderNode.createTemplateAction({
     id: "fs:delete",
     description: "Deletes files and directories from the workspace",
-    examples: examples$3,
+    examples: examples$6,
     schema: {
       input: {
         required: ["files"],
@@ -1262,7 +1262,7 @@ const createFilesystemDeleteAction = () => {
   });
 };
 
-const examples$2 = [
+const examples$5 = [
   {
     description: "Rename specified files ",
     example: yaml__namespace.stringify({
@@ -1288,7 +1288,7 @@ const createFilesystemRenameAction = () => {
   return pluginScaffolderNode.createTemplateAction({
     id: "fs:rename",
     description: "Renames files and directories within the workspace",
-    examples: examples$2,
+    examples: examples$5,
     schema: {
       input: {
         required: ["files"],
@@ -1770,11 +1770,68 @@ async function validateAccessTeam(client, access) {
   }
 }
 
+const examples$4 = [
+  {
+    description: "GitHub Action Workflow Without Inputs.",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: "github:actions:dispatch",
+          name: "Dispatch Github Action Workflow",
+          input: {
+            repoUrl: "github.com?repo=repo&owner=owner",
+            workflowId: "WORKFLOW_ID",
+            branchOrTagName: "main"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "GitHub Action Workflow With Inputs",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: "github:actions:dispatch",
+          name: "Dispatch Github Action Workflow with inputs",
+          input: {
+            repoUrl: "github.com?repo=repo&owner=owner",
+            workflowId: "WORKFLOW_ID",
+            branchOrTagName: "main",
+            workflowInputs: {
+              input1: "value1",
+              input2: "value2"
+            }
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "GitHub Action Workflow With Custom Token",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          action: "github:actions:dispatch",
+          name: "Dispatch GitHub Action Workflow (custom token)",
+          input: {
+            repoUrl: "github.com?repo=reponame&owner=owner",
+            workflowId: "WORKFLOW_ID",
+            branchOrTagName: "release-1.0",
+            token: "${{ secrets.MY_CUSTOM_TOKEN }}"
+          }
+        }
+      ]
+    })
+  }
+];
+
 function createGithubActionsDispatchAction(options) {
   const { integrations, githubCredentialsProvider } = options;
   return pluginScaffolderNode.createTemplateAction({
     id: "github:actions:dispatch",
     description: "Dispatches a GitHub Action workflow for a given branch or tag",
+    examples: examples$4,
     schema: {
       input: {
         type: "object",
@@ -2170,7 +2227,7 @@ const commitHash = {
   type: "string"
 };
 
-const examples$1 = [
+const examples$3 = [
   {
     description: "Creates a GitHub repository with default configuration.",
     example: yaml__default["default"].stringify({
@@ -2223,7 +2280,7 @@ function createGithubRepoCreateAction(options) {
   return pluginScaffolderNode.createTemplateAction({
     id: "github:repo:create",
     description: "Creates a GitHub repository.",
-    examples: examples$1,
+    examples: examples$3,
     schema: {
       input: {
         type: "object",
@@ -2330,7 +2387,7 @@ function createGithubRepoCreateAction(options) {
   });
 }
 
-const examples = [
+const examples$2 = [
   {
     description: "Setup repo with no modifications to branch protection rules",
     example: yaml__default["default"].stringify({
@@ -2382,7 +2439,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: examples$2,
     schema: {
       input: {
         type: "object",
@@ -2929,7 +2986,7 @@ function createPublishAzureAction(options) {
       }
     },
     async handler(ctx) {
-      var _a;
+      var _a, _b;
       const {
         repoUrl,
         defaultBranch = "master",
@@ -2946,18 +3003,16 @@ function createPublishAzureAction(options) {
           `Invalid URL provider was included in the repo URL to create ${ctx.input.repoUrl}, missing organization`
         );
       }
-      const integrationConfig = integrations.azure.byHost(host);
-      if (!integrationConfig) {
+      const url = `https://${host}/${organization}`;
+      const credentialProvider = integration.DefaultAzureDevOpsCredentialsProvider.fromIntegrations(integrations);
+      const credentials = await credentialProvider.getCredentials({ url });
+      if (credentials === void 0 && ctx.input.token === void 0) {
         throw new errors.InputError(
-          `No matching integration configuration for host ${host}, please check your integrations config`
+          `No credentials provided ${url}, please check your integrations config`
         );
       }
-      if (!integrationConfig.config.token && !ctx.input.token) {
-        throw new errors.InputError(`No token provided for Azure Integration ${host}`);
-      }
-      const token = (_a = ctx.input.token) != null ? _a : integrationConfig.config.token;
-      const authHandler = azureDevopsNodeApi.getPersonalAccessTokenHandler(token);
-      const webApi = new azureDevopsNodeApi.WebApi(`https://${host}/${organization}`, authHandler);
+      const authHandler = ctx.input.token || (credentials == null ? void 0 : credentials.type) === "pat" ? azureDevopsNodeApi.getPersonalAccessTokenHandler((_a = ctx.input.token) != null ? _a : credentials.token) : azureDevopsNodeApi.getBearerHandler(credentials.token);
+      const webApi = new azureDevopsNodeApi.WebApi(url, authHandler);
       const client = await webApi.getGitApi();
       const createOptions = { name: repo };
       const returnedRepo = await client.createRepository(createOptions, owner);
@@ -2982,14 +3037,15 @@ function createPublishAzureAction(options) {
         name: gitAuthorName ? gitAuthorName : config.getOptionalString("scaffolder.defaultAuthor.name"),
         email: gitAuthorEmail ? gitAuthorEmail : config.getOptionalString("scaffolder.defaultAuthor.email")
       };
+      const auth = ctx.input.token || (credentials == null ? void 0 : credentials.type) === "pat" ? {
+        username: "notempty",
+        password: (_b = ctx.input.token) != null ? _b : credentials.token
+      } : { token: credentials.token };
       const commitResult = await initRepoAndPush({
         dir: getRepoSourceDirectory(ctx.workspacePath, ctx.input.sourcePath),
         remoteUrl,
         defaultBranch,
-        auth: {
-          username: "notempty",
-          password: token
-        },
+        auth,
         logger: ctx.logger,
         commitMessage: gitCommitMessage ? gitCommitMessage : config.getOptionalString("scaffolder.defaultCommitMessage"),
         gitAuthorInfo
@@ -4166,11 +4222,63 @@ Change-Id: ${changeId}`;
   });
 }
 
+const examples$1 = [
+  {
+    description: "Initializes a git repository of contents in workspace and publish it to GitHub with default configuration.",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          id: "publish",
+          action: "publish:github",
+          name: "Publish to GitHub",
+          input: {
+            repoUrl: "github.com?repo=repo&owner=owner"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Add a description.",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          id: "publish",
+          action: "publish:github",
+          name: "Publish to GitHub",
+          input: {
+            repoUrl: "github.com?repo=repo&owner=owner",
+            description: "Initialize a git repository"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Change visibility of the repository.",
+    example: yaml__default["default"].stringify({
+      steps: [
+        {
+          id: "publish",
+          action: "publish:github",
+          name: "Publish to GitHub",
+          input: {
+            repoUrl: "github.com?repo=repo&owner=owner",
+            description: "Initialize a git repository",
+            repoVisibility: "public"
+          }
+        }
+      ]
+    })
+  }
+];
+
 function createPublishGithubAction(options) {
   const { integrations, config, githubCredentialsProvider } = options;
   return pluginScaffolderNode.createTemplateAction({
     id: "publish:github",
     description: "Initializes a git repository of contents in workspace and publishes it to GitHub.",
+    examples: examples$1,
     schema: {
       input: {
         type: "object",
@@ -4648,11 +4756,63 @@ const createPublishGithubPullRequestAction = (options) => {
   }
 };
 
+const examples = [
+  {
+    description: "Initializes a git repository of the content in the workspace, and publishes it to GitLab.",
+    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"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Add a description.",
+    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",
+            description: "Initialize a git repository"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Sets the commit message on the repository. The default value is `initial commit`.",
+    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",
+            description: "Initialize a git repository",
+            gitCommitMessage: "Started a project."
+          }
+        }
+      ]
+    })
+  }
+];
+
 function createPublishGitlabAction(options) {
   const { integrations, config } = options;
   return pluginScaffolderNode.createTemplateAction({
     id: "publish:gitlab",
     description: "Initializes a git repository of the content in the workspace, and publishes it to GitLab.",
+    examples,
     schema: {
       input: {
         type: "object",
@@ -5306,13 +5466,19 @@ class DatabaseTaskStore {
   }
   async listStaleTasks(options) {
     const { timeoutS } = options;
-    const rawRows = await this.db("tasks").where("status", "processing").andWhere(
-      "last_heartbeat_at",
-      "<=",
-      this.db.client.config.client.includes("sqlite3") ? this.db.raw(`datetime('now', ?)`, [`-${timeoutS} seconds`]) : this.db.raw(`? - interval '${timeoutS} seconds'`, [
-        this.db.fn.now()
-      ])
-    );
+    let heartbeatInterval = this.db.raw(`? - interval '${timeoutS} seconds'`, [
+      this.db.fn.now()
+    ]);
+    if (this.db.client.config.client.includes("mysql")) {
+      heartbeatInterval = this.db.raw(
+        `date_sub(now(), interval ${timeoutS} second)`
+      );
+    } else if (this.db.client.config.client.includes("sqlite3")) {
+      heartbeatInterval = this.db.raw(`datetime('now', ?)`, [
+        `-${timeoutS} seconds`
+      ]);
+    }
+    const rawRows = await this.db("tasks").where("status", "processing").andWhere("last_heartbeat_at", "<=", heartbeatInterval);
     const tasks = rawRows.map((row) => ({
       taskId: row.id
     }));
@@ -6995,4 +7161,4 @@ exports.createRouter = createRouter;
 exports.createWaitAction = createWaitAction;
 exports.scaffolderActionRules = scaffolderActionRules;
 exports.scaffolderTemplateRules = scaffolderTemplateRules;
-//# sourceMappingURL=ScaffolderEntitiesProcessor-4b7489dd.cjs.js.map
+//# sourceMappingURL=ScaffolderEntitiesProcessor-96675669.cjs.js.map