@backstage/plugin-scaffolder-common 0.2.0 → 0.2.3

package/CHANGELOG.md

@@ -1,5 +1,35 @@
 # @backstage/plugin-scaffolder-common
 
+## 0.2.3
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/catalog-model@0.12.0
+
+## 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
+
+- Fix for the previous release with missing type declarations.
+- Updated dependencies
+  - @backstage/catalog-model@0.10.1
+  - @backstage/types@0.1.3
+
 ## 0.2.0
 
 ### Minor Changes

package/dist/index.d.ts

@@ -0,0 +1,151 @@
+import { JsonObject, JsonValue } from '@backstage/types';
+import { Entity, KindValidator } from '@backstage/catalog-model';
+
+/**
+ * Metadata about the Template that was the originator of a scaffolder task, as
+ * 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.
+ *
+ * @public
+ */
+interface TaskStep {
+    id: string;
+    name: string;
+    action: string;
+    input?: JsonObject;
+    if?: string | boolean;
+}
+/**
+ * A scaffolder task as stored in the database, generated from a v1beta2
+ * apiVersion Template.
+ *
+ * @public
+ * @deprecated Please convert your templates to TaskSpecV1beta3 on apiVersion
+ *             scaffolder.backstage.io/v1beta3
+ */
+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
+ * apiVersion Template.
+ *
+ * @public
+ */
+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.
+ *
+ * @public
+ */
+declare type TaskSpec = TaskSpecV1beta2 | TaskSpecV1beta3;
+
+/**
+ * Backstage catalog Template kind Entity. Templates are used by the Scaffolder
+ * plugin to create new entities, such as Components.
+ *
+ * @public
+ * @deprecated Please convert your templates to TemplateEntityV1beta3 on
+ *             apiVersion scaffolder.backstage.io/v1beta3
+ */
+interface TemplateEntityV1beta2 extends Entity {
+    apiVersion: 'backstage.io/v1beta2';
+    kind: 'Template';
+    spec: {
+        type: string;
+        parameters?: JsonObject | JsonObject[];
+        steps: Array<{
+            id?: string;
+            name?: string;
+            action: string;
+            input?: JsonObject;
+            if?: string | boolean;
+        }>;
+        output?: {
+            [name: string]: string;
+        };
+        owner?: string;
+    };
+}
+/**
+ * Entity data validator for {@link TemplateEntityV1beta2}.
+ *
+ * @public
+ * @deprecated Please convert your templates to TemplateEntityV1beta3 on
+ *             apiVersion scaffolder.backstage.io/v1beta3
+ */
+declare const templateEntityV1beta2Validator: KindValidator;
+
+/**
+ * Backstage catalog Template kind Entity. Templates are used by the Scaffolder
+ * plugin to create new entities, such as Components.
+ *
+ * @public
+ */
+interface TemplateEntityV1beta3 extends Entity {
+    apiVersion: 'scaffolder.backstage.io/v1beta3';
+    kind: 'Template';
+    spec: {
+        type: string;
+        parameters?: JsonObject | JsonObject[];
+        steps: Array<{
+            id?: string;
+            name?: string;
+            action: string;
+            input?: JsonObject;
+            if?: string | boolean;
+        }>;
+        output?: {
+            [name: string]: string;
+        };
+        owner?: string;
+    };
+}
+/**
+ * Entity data validator for {@link TemplateEntityV1beta3}.
+ *
+ * @public
+ */
+declare const templateEntityV1beta3Validator: KindValidator;
+
+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.0",
+  "version": "0.2.3",
   "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.0",
-    "@backstage/types": "^0.1.2"
+    "@backstage/catalog-model": "^0.12.0",
+    "@backstage/types": "^0.1.3"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.14.0"
+    "@backstage/cli": "^0.15.0"
   },
-  "gitHead": "4805c3d13ce9bfc369e53c271b1b95e722b3b4dc",
+  "gitHead": "04bb0dd824b78f6b57dac62c3015e681f094045c",
   "module": "dist/index.esm.js"
 }