@backstage/plugin-scaffolder-node 0.6.2 → 0.6.3-next.1

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @backstage/plugin-scaffolder-node
 
+## 0.6.3-next.1
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/types@1.2.1-next.0
+  - @backstage/backend-plugin-api@1.1.1-next.1
+  - @backstage/catalog-model@1.7.3-next.0
+  - @backstage/errors@1.2.7-next.0
+  - @backstage/plugin-scaffolder-common@1.5.9-next.0
+  - @backstage/integration@1.16.1-next.0
+
+## 0.6.3-next.0
+
+### Patch Changes
+
+- 5d9e5c8: Added the ability to use `${{ context.task.id }}` in nunjucks templating, as well as `ctx.task.id` in actions to get the current task ID.
+- 7dd0013: Deprecate the `logStream` option in `executeShellCommand`, replacing it with a logger instance.
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.1.1-next.0
+  - @backstage/catalog-model@1.7.2
+  - @backstage/errors@1.2.6
+  - @backstage/integration@1.16.0
+  - @backstage/types@1.2.0
+  - @backstage/plugin-scaffolder-common@1.5.8
+
 ## 0.6.2
 
 ### Patch Changes

package/dist/actions/executeShellCommand.cjs.js

@@ -8,15 +8,22 @@ async function executeShellCommand(options) {
     command,
     args,
     options: spawnOptions,
+    logger,
     logStream = new stream.PassThrough()
   } = options;
   await new Promise((resolve, reject) => {
     const process = child_process.spawn(command, args, spawnOptions);
-    process.stdout.on("data", (stream) => {
-      logStream.write(stream);
+    process.stdout.on("data", (chunk) => {
+      logStream?.write(chunk);
+      logger?.info(
+        Buffer.isBuffer(chunk) ? chunk.toString("utf8").trim() : chunk.trim()
+      );
     });
-    process.stderr.on("data", (stream) => {
-      logStream.write(stream);
+    process.stderr.on("data", (chunk) => {
+      logStream?.write(chunk);
+      logger?.error(
+        Buffer.isBuffer(chunk) ? chunk.toString("utf8").trim() : chunk.trim()
+      );
     });
     process.on("error", (error) => {
       return reject(error);

package/dist/actions/executeShellCommand.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"executeShellCommand.cjs.js","sources":["../../src/actions/executeShellCommand.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { spawn, SpawnOptionsWithoutStdio } from 'child_process';\nimport { PassThrough, Writable } from 'stream';\n\n/**\n * Options for {@link executeShellCommand}.\n *\n * @public\n */\nexport type ExecuteShellCommandOptions = {\n  /** command to run */\n  command: string;\n  /** arguments to pass the command */\n  args: string[];\n  /** options to pass to spawn */\n  options?: SpawnOptionsWithoutStdio;\n  /** stream to capture stdout and stderr output */\n  logStream?: Writable;\n};\n\n/**\n * Run a command in a sub-process, normally a shell command.\n *\n * @public\n */\nexport async function executeShellCommand(\n  options: ExecuteShellCommandOptions,\n): Promise<void> {\n  const {\n    command,\n    args,\n    options: spawnOptions,\n    logStream = new PassThrough(),\n  } = options;\n\n  await new Promise<void>((resolve, reject) => {\n    const process = spawn(command, args, spawnOptions);\n\n    process.stdout.on('data', stream => {\n      logStream.write(stream);\n    });\n\n    process.stderr.on('data', stream => {\n      logStream.write(stream);\n    });\n\n    process.on('error', error => {\n      return reject(error);\n    });\n\n    process.on('close', code => {\n      if (code !== 0) {\n        return reject(\n          new Error(`Command ${command} failed, exit code: ${code}`),\n        );\n      }\n      return resolve();\n    });\n  });\n}\n"],"names":["PassThrough","spawn"],"mappings":";;;;;AAwCA,eAAsB,oBACpB,OACe,EAAA;AACf,EAAM,MAAA;AAAA,IACJ,OAAA;AAAA,IACA,IAAA;AAAA,IACA,OAAS,EAAA,YAAA;AAAA,IACT,SAAA,GAAY,IAAIA,kBAAY;AAAA,GAC1B,GAAA,OAAA;AAEJ,EAAA,MAAM,IAAI,OAAA,CAAc,CAAC,OAAA,EAAS,MAAW,KAAA;AAC3C,IAAA,MAAM,OAAU,GAAAC,mBAAA,CAAM,OAAS,EAAA,IAAA,EAAM,YAAY,CAAA;AAEjD,IAAQ,OAAA,CAAA,MAAA,CAAO,EAAG,CAAA,MAAA,EAAQ,CAAU,MAAA,KAAA;AAClC,MAAA,SAAA,CAAU,MAAM,MAAM,CAAA;AAAA,KACvB,CAAA;AAED,IAAQ,OAAA,CAAA,MAAA,CAAO,EAAG,CAAA,MAAA,EAAQ,CAAU,MAAA,KAAA;AAClC,MAAA,SAAA,CAAU,MAAM,MAAM,CAAA;AAAA,KACvB,CAAA;AAED,IAAQ,OAAA,CAAA,EAAA,CAAG,SAAS,CAAS,KAAA,KAAA;AAC3B,MAAA,OAAO,OAAO,KAAK,CAAA;AAAA,KACpB,CAAA;AAED,IAAQ,OAAA,CAAA,EAAA,CAAG,SAAS,CAAQ,IAAA,KAAA;AAC1B,MAAA,IAAI,SAAS,CAAG,EAAA;AACd,QAAO,OAAA,MAAA;AAAA,UACL,IAAI,KAAM,CAAA,CAAA,QAAA,EAAW,OAAO,CAAA,oBAAA,EAAuB,IAAI,CAAE,CAAA;AAAA,SAC3D;AAAA;AAEF,MAAA,OAAO,OAAQ,EAAA;AAAA,KAChB,CAAA;AAAA,GACF,CAAA;AACH;;;;"}
+{"version":3,"file":"executeShellCommand.cjs.js","sources":["../../src/actions/executeShellCommand.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { LoggerService } from '@backstage/backend-plugin-api';\nimport { spawn, SpawnOptionsWithoutStdio } from 'child_process';\nimport { PassThrough, Writable } from 'stream';\n\n/**\n * Options for {@link executeShellCommand}.\n *\n * @public\n */\nexport type ExecuteShellCommandOptions = {\n  /** command to run */\n  command: string;\n  /** arguments to pass the command */\n  args: string[];\n  /** options to pass to spawn */\n  options?: SpawnOptionsWithoutStdio;\n  /** logger to capture stdout and stderr output */\n  logger?: LoggerService;\n  /**\n   * stream to capture stdout and stderr output\n   * @deprecated  please provide a logger instead.\n   */\n  logStream?: Writable;\n};\n\n/**\n * Run a command in a sub-process, normally a shell command.\n *\n * @public\n */\nexport async function executeShellCommand(\n  options: ExecuteShellCommandOptions,\n): Promise<void> {\n  const {\n    command,\n    args,\n    options: spawnOptions,\n    logger,\n    logStream = new PassThrough(),\n  } = options;\n\n  await new Promise<void>((resolve, reject) => {\n    const process = spawn(command, args, spawnOptions);\n\n    process.stdout.on('data', chunk => {\n      logStream?.write(chunk);\n      logger?.info(\n        Buffer.isBuffer(chunk) ? chunk.toString('utf8').trim() : chunk.trim(),\n      );\n    });\n    process.stderr.on('data', chunk => {\n      logStream?.write(chunk);\n      logger?.error(\n        Buffer.isBuffer(chunk) ? chunk.toString('utf8').trim() : chunk.trim(),\n      );\n    });\n    process.on('error', error => {\n      return reject(error);\n    });\n\n    process.on('close', code => {\n      if (code !== 0) {\n        return reject(\n          new Error(`Command ${command} failed, exit code: ${code}`),\n        );\n      }\n      return resolve();\n    });\n  });\n}\n"],"names":["PassThrough","spawn"],"mappings":";;;;;AA8CA,eAAsB,oBACpB,OACe,EAAA;AACf,EAAM,MAAA;AAAA,IACJ,OAAA;AAAA,IACA,IAAA;AAAA,IACA,OAAS,EAAA,YAAA;AAAA,IACT,MAAA;AAAA,IACA,SAAA,GAAY,IAAIA,kBAAY;AAAA,GAC1B,GAAA,OAAA;AAEJ,EAAA,MAAM,IAAI,OAAA,CAAc,CAAC,OAAA,EAAS,MAAW,KAAA;AAC3C,IAAA,MAAM,OAAU,GAAAC,mBAAA,CAAM,OAAS,EAAA,IAAA,EAAM,YAAY,CAAA;AAEjD,IAAQ,OAAA,CAAA,MAAA,CAAO,EAAG,CAAA,MAAA,EAAQ,CAAS,KAAA,KAAA;AACjC,MAAA,SAAA,EAAW,MAAM,KAAK,CAAA;AACtB,MAAQ,MAAA,EAAA,IAAA;AAAA,QACN,MAAA,CAAO,QAAS,CAAA,KAAK,CAAI,GAAA,KAAA,CAAM,QAAS,CAAA,MAAM,CAAE,CAAA,IAAA,EAAS,GAAA,KAAA,CAAM,IAAK;AAAA,OACtE;AAAA,KACD,CAAA;AACD,IAAQ,OAAA,CAAA,MAAA,CAAO,EAAG,CAAA,MAAA,EAAQ,CAAS,KAAA,KAAA;AACjC,MAAA,SAAA,EAAW,MAAM,KAAK,CAAA;AACtB,MAAQ,MAAA,EAAA,KAAA;AAAA,QACN,MAAA,CAAO,QAAS,CAAA,KAAK,CAAI,GAAA,KAAA,CAAM,QAAS,CAAA,MAAM,CAAE,CAAA,IAAA,EAAS,GAAA,KAAA,CAAM,IAAK;AAAA,OACtE;AAAA,KACD,CAAA;AACD,IAAQ,OAAA,CAAA,EAAA,CAAG,SAAS,CAAS,KAAA,KAAA;AAC3B,MAAA,OAAO,OAAO,KAAK,CAAA;AAAA,KACpB,CAAA;AAED,IAAQ,OAAA,CAAA,EAAA,CAAG,SAAS,CAAQ,IAAA,KAAA;AAC1B,MAAA,IAAI,SAAS,CAAG,EAAA;AACd,QAAO,OAAA,MAAA;AAAA,UACL,IAAI,KAAM,CAAA,CAAA,QAAA,EAAW,OAAO,CAAA,oBAAA,EAAuB,IAAI,CAAE,CAAA;AAAA,SAC3D;AAAA;AAEF,MAAA,OAAO,OAAQ,EAAA;AAAA,KAChB,CAAA;AAAA,GACF,CAAA;AACH;;;;"}

package/dist/index.d.ts

@@ -2,7 +2,7 @@
 import { Logger } from 'winston';
 import { Writable } from 'stream';
 import { JsonObject, JsonValue, Observable } from '@backstage/types';
-import { BackstageCredentials, UrlReaderService } from '@backstage/backend-plugin-api';
+import { BackstageCredentials, LoggerService, UrlReaderService } from '@backstage/backend-plugin-api';
 import { TaskSpec, TemplateInfo } from '@backstage/plugin-scaffolder-common';
 import { UserEntity } from '@backstage/catalog-model';
 import { Schema } from 'jsonschema';
@@ -194,6 +194,12 @@ type ActionContext<TActionInput extends JsonObject, TActionOutput extends JsonOb
      * Get the credentials for the current request
      */
     getInitiatorCredentials(): Promise<BackstageCredentials>;
+    /**
+     * Task information
+     */
+    task: {
+        id: string;
+    };
     templateInfo?: TemplateInfo;
     /**
      * Whether this action invocation is a dry-run or not.
@@ -274,7 +280,12 @@ type ExecuteShellCommandOptions = {
     args: string[];
     /** options to pass to spawn */
     options?: SpawnOptionsWithoutStdio;
-    /** stream to capture stdout and stderr output */
+    /** logger to capture stdout and stderr output */
+    logger?: LoggerService;
+    /**
+     * stream to capture stdout and stderr output
+     * @deprecated  please provide a logger instead.
+     */
     logStream?: Writable;
 };
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-scaffolder-node",
-  "version": "0.6.2",
+  "version": "0.6.3-next.1",
   "description": "The plugin-scaffolder-node module for @backstage/plugin-scaffolder-backend",
   "backstage": {
     "role": "node-library",
@@ -63,12 +63,12 @@
   },
   "dependencies": {
     "@backstage/backend-common": "^0.25.0",
-    "@backstage/backend-plugin-api": "^1.1.0",
-    "@backstage/catalog-model": "^1.7.2",
-    "@backstage/errors": "^1.2.6",
-    "@backstage/integration": "^1.16.0",
-    "@backstage/plugin-scaffolder-common": "^1.5.8",
-    "@backstage/types": "^1.2.0",
+    "@backstage/backend-plugin-api": "1.1.1-next.1",
+    "@backstage/catalog-model": "1.7.3-next.0",
+    "@backstage/errors": "1.2.7-next.0",
+    "@backstage/integration": "1.16.1-next.0",
+    "@backstage/plugin-scaffolder-common": "1.5.9-next.0",
+    "@backstage/types": "1.2.1-next.0",
     "concat-stream": "^2.0.0",
     "fs-extra": "^11.2.0",
     "globby": "^11.0.0",
@@ -81,8 +81,8 @@
     "zod-to-json-schema": "^3.20.4"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^1.2.0",
-    "@backstage/cli": "^0.29.4",
-    "@backstage/config": "^1.3.1"
+    "@backstage/backend-test-utils": "1.2.1-next.1",
+    "@backstage/cli": "0.29.5-next.1",
+    "@backstage/config": "1.3.2-next.0"
   }
 }