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

Comparing version 0.3.0 to 1.0.0

CHANGELOG.md

 # @backstage/plugin-scaffolder-common
 
+## 1.0.0
+
+### 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@1.0.0
+  - @backstage/types@1.0.0
+
 ## 0.3.0
@@ -4,0 +17,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.3.0",
+  "version": "1.0.0",
   "main": "dist/index.cjs.js",
@@ -42,10 +42,10 @@ "types": "dist/index.d.ts",
   "dependencies": {
-    "@backstage/catalog-model": "^0.13.0",
-    "@backstage/types": "^0.1.3"
+    "@backstage/catalog-model": "^1.0.0",
+    "@backstage/types": "^1.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.15.2"
+    "@backstage/cli": "^0.16.0"
   },
-  "gitHead": "60c4e39d1fcaeb10d6488ada1d907f34dc2a105a",
+  "gitHead": "e9496f746b31600dbfac7fa76987479e66426257",
   "module": "dist/index.esm.js"
 }

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

40603

15.08%

Lines of code

615

12.02%

Number of low quality alerts

0

-100%

Dependency changes

• + Added

  @backstage/catalog-model@1.7.4
  (transitive)

• + Added

  @backstage/errors@1.2.7
  (transitive)

• + Added

  @backstage/types@1.2.1
  (transitive)

• + Added

  ajv@8.17.1
  (transitive)

• + Added

  fast-uri@3.0.6
  (transitive)

• - Removed

  @backstage/catalog-model@0.13.0
  (transitive)

• - Removed

  @backstage/config@0.1.15
  (transitive)

• - Removed

  @backstage/errors@0.2.2
  (transitive)

• - Removed

  @backstage/types@0.1.3
  (transitive)

• - Removed

  ajv@7.2.4
  (transitive)

• - Removed

  cross-fetch@3.2.0
  (transitive)

• - Removed

  json-schema@0.4.0
  (transitive)

• - Removed

  node-fetch@2.7.0
  (transitive)

• - Removed

  punycode@2.3.1
  (transitive)

• - Removed

  tr46@0.0.3
  (transitive)

• - Removed

  uri-js@4.4.1
  (transitive)

• - Removed

  uuid@8.3.2
  (transitive)

• - Removed

  webidl-conversions@3.0.1
  (transitive)

• - Removed

  whatwg-url@5.0.0
  (transitive)

• Updated

  @backstage/catalog-model@^1.0.0

• Updated

  @backstage/types@^1.0.0