@backstage/plugin-scaffolder-backend 1.11.1-next.0 → 1.12.0-next.2

package/CHANGELOG.md

@@ -1,5 +1,48 @@
 # @backstage/plugin-scaffolder-backend
 
+## 1.12.0-next.2
+
+### Patch Changes
+
+- 860de10fa67: Make identity valid if subject of token is a backstage server-2-server auth token
+- 65454876fb2: Minor API report tweaks
+- 9968f455921: catalog write action should allow any shape of object
+- Updated dependencies
+  - @backstage/plugin-auth-node@0.2.12-next.2
+  - @backstage/backend-tasks@0.5.0-next.2
+  - @backstage/backend-common@0.18.3-next.2
+  - @backstage/backend-plugin-api@0.4.1-next.2
+  - @backstage/plugin-catalog-backend@1.8.0-next.2
+  - @backstage/plugin-catalog-node@1.3.4-next.2
+  - @backstage/plugin-scaffolder-node@0.1.1-next.2
+  - @backstage/config@1.0.7-next.0
+  - @backstage/integration@1.4.3-next.0
+
+## 1.12.0-next.1
+
+### Minor Changes
+
+- 7d724d8ef56: Added the ability to be able to define an actions `input` and `output` schema using `zod` instead of hand writing types and `jsonschema`
+
+### Patch Changes
+
+- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
+- Updated dependencies
+  - @backstage/errors@1.1.5-next.0
+  - @backstage/backend-common@0.18.3-next.1
+  - @backstage/catalog-client@1.4.0-next.1
+  - @backstage/integration@1.4.3-next.0
+  - @backstage/plugin-auth-node@0.2.12-next.1
+  - @backstage/plugin-catalog-backend@1.8.0-next.1
+  - @backstage/backend-plugin-api@0.4.1-next.1
+  - @backstage/backend-tasks@0.4.4-next.1
+  - @backstage/config@1.0.7-next.0
+  - @backstage/catalog-model@1.2.1-next.1
+  - @backstage/types@1.0.2
+  - @backstage/plugin-catalog-node@1.3.4-next.1
+  - @backstage/plugin-scaffolder-common@1.2.6-next.1
+  - @backstage/plugin-scaffolder-node@0.1.1-next.1
+
 ## 1.11.1-next.0
 
 ### Patch Changes

package/README.md

@@ -1,7 +1,7 @@
 # Scaffolder Backend
 
 This is the backend for the default Backstage [software
-templates](https://backstage.io/docs/features/software-templates/software-templates-index).
+templates](https://backstage.io/docs/features/software-templates/).
 This provides the API for the frontend [scaffolder
 plugin](https://github.com/backstage/backstage/tree/master/plugins/scaffolder),
 as well as the built-in template actions, tasks and stages.

package/alpha/package.json

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

package/dist/alpha.cjs.js

@@ -13,6 +13,7 @@ var pluginScaffolderNode = require('@backstage/plugin-scaffolder-node');
 var errors = require('@backstage/errors');
 var yaml = require('yaml');
 var fs = require('fs-extra');
+var zod = require('zod');
 var path = require('path');
 var globby = require('globby');
 var isbinaryfile = require('isbinaryfile');
@@ -39,7 +40,6 @@ var jsonschema = require('jsonschema');
 var promClient = require('prom-client');
 var express = require('express');
 var Router = require('express-promise-router');
-var zod = require('zod');
 var url = require('url');
 var os = require('os');
 
@@ -322,24 +322,16 @@ function createCatalogWriteAction() {
   return pluginScaffolderNode.createTemplateAction({
     id: id$2,
     description: "Writes the catalog-info.yaml for your template",
-    examples: examples$2,
     schema: {
-      input: {
-        type: "object",
-        properties: {
-          filePath: {
-            title: "Catalog file path",
-            description: "Defaults to catalog-info.yaml",
-            type: "string"
-          },
-          entity: {
-            title: "Entity info to write catalog-info.yaml",
-            description: "You can provide the same values used in the Entity schema.",
-            type: "object"
-          }
-        }
-      }
+      input: zod.z.object({
+        filePath: zod.z.string().optional().describe("Defaults to catalog-info.yaml"),
+        // TODO: this should reference an zod entity validator if it existed.
+        entity: zod.z.object({}).passthrough().describe(
+          "You can provide the same values used in the Entity schema."
+        )
+      })
     },
+    examples: examples$2,
     supportsDryRun: true,
     async handler(ctx) {
       ctx.logStream.write(`Writing catalog-info.yaml`);
@@ -3536,11 +3528,12 @@ const defaultClientFactory = async ({
     ...{ throttle: { enabled: false } }
   });
 };
-const createPublishGithubPullRequestAction = ({
-  integrations,
-  githubCredentialsProvider,
-  clientFactory = defaultClientFactory
-}) => {
+const createPublishGithubPullRequestAction = (options) => {
+  const {
+    integrations,
+    githubCredentialsProvider,
+    clientFactory = defaultClientFactory
+  } = options;
   return pluginScaffolderNode.createTemplateAction({
     id: "publish:github:pull-request",
     schema: {
@@ -4436,7 +4429,8 @@ class DatabaseTaskStore {
     });
     return { events };
   }
-  async shutdownTask({ taskId }) {
+  async shutdownTask(options) {
+    const { taskId } = options;
     const message = `This task was marked as stale as it exceeded its timeout`;
     const statusStepEvents = (await this.listEvents({ taskId })).events.filter(
       ({ body }) => body == null ? void 0 : body.stepId
@@ -5241,13 +5235,12 @@ async function findTemplate(options) {
 function isSupportedTemplate(entity) {
   return entity.apiVersion === "scaffolder.backstage.io/v1beta3";
 }
-function buildDefaultIdentityClient({
-  logger
-}) {
+function buildDefaultIdentityClient(options) {
   return {
     getIdentity: async ({ request }) => {
       var _a;
       const header = request.headers.authorization;
+      const { logger } = options;
       if (!header) {
         return void 0;
       }
@@ -5267,6 +5260,9 @@ function buildDefaultIdentityClient({
         if (typeof sub !== "string") {
           throw new TypeError("Expected string sub claim");
         }
+        if (sub === "backstage-server") {
+          return void 0;
+        }
         catalogModel.parseEntityRef(sub);
         return {
           identity: {
@@ -5300,7 +5296,7 @@ async function createRouter(options) {
     additionalTemplateGlobals
   } = options;
   const logger = parentLogger.child({ plugin: "scaffolder" });
-  const identity = options.identity || buildDefaultIdentityClient({ logger });
+  const identity = options.identity || buildDefaultIdentityClient(options);
   const workingDirectory = await getWorkingDirectory(config, logger);
   const integrations = integration.ScmIntegrations.fromConfig(config);
   let taskBroker;