@backstage/plugin-scaffolder-common - npm Package Compare versions

Comparing version 0.0.0-nightly-20220315022536 to 0.0.0-nightly-20220316022902

CHANGELOG.md

 # @backstage/plugin-scaffolder-common
 
-## 0.0.0-nightly-20220315022536
+## 0.0.0-nightly-20220316022902
 
+### Major Changes
+
+- b58c70c223: This package has been promoted to v1.0! To understand how this change affects the package, please check out our [versioning policy](https://backstage.io/docs/overview/versioning-policy).
+
 ### Patch Changes
 
+- c8475ab3bb: Adding some documentation for exported things
 - Updated dependencies
-  - @backstage/catalog-model@0.0.0-nightly-20220315022536
+  - @backstage/catalog-model@0.0.0-nightly-20220316022902
+  - @backstage/types@0.0.0-nightly-20220316022902
 
@@ -10,0 +16,0 @@ ## 0.3.0

dist/index.d.ts

@@ -11,3 +11,9 @@ import { JsonObject, JsonValue } from '@backstage/types';
 declare type TemplateInfo = {
+    /**
+     * The entityRef of the template
+     */
     entityRef: string;
+    /**
+     * Where the template is stored, so we can resolve relative paths for things like `fetch:template` paths.
+     */
     baseUrl?: string;
@@ -21,6 +27,21 @@ };
 interface TaskStep {
+    /**
+     * A unqiue identifier for this step.
+     */
     id: string;
+    /**
+     * A display name to show the user.
+     */
     name: string;
+    /**
+     * The underlying action ID that will be called as part of running this step.
+     */
     action: string;
+    /**
+     * Additional data that will be passed to the action.
+     */
     input?: JsonObject;
+    /**
+     * When this is false, or if the templated value string evaluates to something that is falsy the step will be skipped.
+     */
     if?: string | boolean;
@@ -35,8 +56,26 @@ }
 interface TaskSpecV1beta3 {
+    /**
+     * The apiVersion string of the TaskSpec.
+     */
     apiVersion: 'scaffolder.backstage.io/v1beta3';
+    /**
+     * This is a JSONSchema which is used to render a form in the frontend
+     * to collect user input and validate it against that schema. This can then be used in the `steps` part below to template
+     * variables passed from the user into each action in the template.
+     */
     parameters: JsonObject;
+    /**
+     * A list of steps to be executed in sequence which are defined by the template. These steps are a list of the underlying
+     * javascript action and some optional input parameters that may or may not have been collected from the end user.
+     */
     steps: TaskStep[];
+    /**
+     * The output is an object where template authors can pull out information from template actions and return them in a known standard way.
+     */
     output: {
         [name: string]: JsonValue;
     };
+    /**
+     * Some information about the template that is stored on the task spec.
+     */
     templateInfo?: TemplateInfo;
@@ -58,7 +97,28 @@ }
 interface TemplateEntityV1beta3 extends Entity {
+    /**
+     * The apiVersion string of the TaskSpec.
+     */
     apiVersion: 'scaffolder.backstage.io/v1beta3';
+    /**
+     * The kind of the entity
+     */
     kind: 'Template';
+    /**
+     * The specification of the Template Entity
+     */
     spec: {
+        /**
+         * The type that the Template will create. For example service, website or library.
+         */
         type: string;
+        /**
+         * This is a JSONSchema or an array of JSONSchema's which is used to render a form in the frontend
+         * to collect user input and validate it against that schema. This can then be used in the `steps` part below to template
+         * variables passed from the user into each action in the template.
+         */
         parameters?: JsonObject | JsonObject[];
+        /**
+         * A list of steps to be executed in sequence which are defined by the template. These steps are a list of the underlying
+         * javascript action and some optional input parameters that may or may not have been collected from the end user.
+         */
         steps: Array<{
@@ -71,5 +131,11 @@ id?: string;
         }>;
+        /**
+         * The output is an object where template authors can pull out information from template actions and return them in a known standard way.
+         */
         output?: {
             [name: string]: string;
         };
+        /**
+         * The owner entityRef of the TemplateEntity
+         */
         owner?: string;
@@ -76,0 +142,0 @@ };

package.json

 {
   "name": "@backstage/plugin-scaffolder-common",
   "description": "Common functionalities for the scaffolder, to be shared between scaffolder and scaffolder-backend plugin",
-  "version": "0.0.0-nightly-20220315022536",
+  "version": "0.0.0-nightly-20220316022902",
   "main": "dist/index.cjs.js",
@@ -42,9 +42,9 @@ "types": "dist/index.d.ts",
   "dependencies": {
-    "@backstage/catalog-model": "^0.0.0-nightly-20220315022536",
-    "@backstage/types": "^0.1.3"
+    "@backstage/catalog-model": "^0.0.0-nightly-20220316022902",
+    "@backstage/types": "^0.0.0-nightly-20220316022902"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.0.0-nightly-20220315022536"
+    "@backstage/cli": "^0.0.0-nightly-20220316022902"
   },
   "module": "dist/index.esm.js"
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

29862

increased by20.8%

Lines of code

615

increased by12.02%

Dependency changes

• + Added@backstage/types@0.0.0-nightly-20241119023621(transitive)

• - Removed@backstage/types@0.1.3(transitive)

• Updated@backstage/catalog-model@^0.0.0-nightly-20220316022902

• Updated@backstage/types@^0.0.0-nightly-20220316022902