@backstage/plugin-scaffolder-common 0.2.1 → 0.2.2

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @backstage/plugin-scaffolder-common
 
+## 0.2.2
+
+### Patch Changes
+
+- a4d53fe18e: **DEPRECATED** - The `TaskSpec.metadata` and `TaskSpec.baseUrl` has been deprecated in favour of the new `TaskSpec.templateInfo`.
+  The `baseUrl` is now found on the `templateInfo` object, and the name can be inferred from the `templateInfo.entityRef` property.
+
+  Usages of `TaskSpec.metadata.name` or `ctx.metadata.name` in Actions should migrate to using `parseEntityRef(taskSpec.templateInfo.entityRef)` to get the parsed entity triplet.
+
+  Usages of `ctx.baseUrl` in Actions should migrate to using `ctx.templateInfo.baseUrl` instead.
+
+- Updated dependencies
+  - @backstage/catalog-model@0.11.0
+
 ## 0.2.1
 
 ### Patch Changes

package/dist/index.d.ts

@@ -6,10 +6,21 @@ import { Entity, KindValidator } from '@backstage/catalog-model';
  * stored in the database.
  *
  * @public
+ * @deprecated use templateInfo on the spec instead
  */
 declare type TemplateMetadata = {
     name: string;
 };
+/**
+ * Information about a template that is stored on a task specification.
+ * Includes a stringified entityRef, and the baseUrl which is usually the relative path of the template definition
+ *
+ * @public
+ */
+declare type TemplateInfo = {
+    entityRef: string;
+    baseUrl?: string;
+};
 /**
  * An individual step of a scaffolder task, as stored in the database.
  *
@@ -32,13 +43,16 @@ interface TaskStep {
  */
 interface TaskSpecV1beta2 {
     apiVersion: 'backstage.io/v1beta2';
+    /** @deprecated use templateInfo.baseUrl instead */
     baseUrl?: string;
     values: JsonObject;
     steps: TaskStep[];
     output: {
         [name: string]: string;
     };
+    /** @deprecated use templateInfo instead */
     metadata?: TemplateMetadata;
+    templateInfo?: TemplateInfo;
 }
 /**
  * A scaffolder task as stored in the database, generated from a v1beta3
@@ -48,13 +62,16 @@ interface TaskSpecV1beta2 {
  */
 interface TaskSpecV1beta3 {
     apiVersion: 'scaffolder.backstage.io/v1beta3';
+    /** @deprecated use templateInfo.baseUrl instead */
     baseUrl?: string;
     parameters: JsonObject;
     steps: TaskStep[];
     output: {
         [name: string]: JsonValue;
     };
+    /** @deprecated use templateInfo instead */
     metadata?: TemplateMetadata;
+    templateInfo?: TemplateInfo;
 }
 /**
  * A scaffolder task as stored in the database, generated from a Template.
@@ -131,4 +148,4 @@ interface TemplateEntityV1beta3 extends Entity {
  */
 declare const templateEntityV1beta3Validator: KindValidator;
 
-export { TaskSpec, TaskSpecV1beta2, TaskSpecV1beta3, TaskStep, TemplateEntityV1beta2, TemplateEntityV1beta3, TemplateMetadata, templateEntityV1beta2Validator, templateEntityV1beta3Validator };
+export { TaskSpec, TaskSpecV1beta2, TaskSpecV1beta3, TaskStep, TemplateEntityV1beta2, TemplateEntityV1beta3, TemplateInfo, TemplateMetadata, templateEntityV1beta2Validator, templateEntityV1beta3Validator };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/plugin-scaffolder-common",
   "description": "Common functionalities for the scaffolder, to be shared between scaffolder and scaffolder-backend plugin",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -39,12 +39,12 @@
     "url": "https://github.com/backstage/backstage/issues"
   },
   "dependencies": {
-    "@backstage/catalog-model": "^0.10.1",
+    "@backstage/catalog-model": "^0.11.0",
     "@backstage/types": "^0.1.3"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.14.0"
+    "@backstage/cli": "^0.14.1"
   },
-  "gitHead": "e244b348c473700e7d5e5fbcef38bd9f9fd1d0ba",
+  "gitHead": "a15da6ea1e3e8adc37be98be064071c8b5279b4a",
   "module": "dist/index.esm.js"
 }