@backstage/plugin-scaffolder-backend 1.26.0-next.1 → 1.26.0-next.2

package/dist/scaffolder/actions/builtin/catalog/fetch.examples.cjs.js

@@ -0,0 +1,43 @@
+'use strict';
+
+var yaml = require('yaml');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var yaml__default = /*#__PURE__*/_interopDefaultCompat(yaml);
+
+const examples = [
+  {
+    description: "Fetch entity by reference",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          action: "catalog:fetch",
+          id: "fetch",
+          name: "Fetch catalog entity",
+          input: {
+            entityRef: "component:default/name"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Fetch multiple entities by reference",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          action: "catalog:fetch",
+          id: "fetchMultiple",
+          name: "Fetch catalog entities",
+          input: {
+            entityRefs: ["component:default/name"]
+          }
+        }
+      ]
+    })
+  }
+];
+
+exports.examples = examples;
+//# sourceMappingURL=fetch.examples.cjs.js.map

package/dist/scaffolder/actions/builtin/catalog/fetch.examples.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch.examples.cjs.js","sources":["../../../../../src/scaffolder/actions/builtin/catalog/fetch.examples.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 { TemplateExample } from '@backstage/plugin-scaffolder-node';\nimport yaml from 'yaml';\n\nexport const examples: TemplateExample[] = [\n  {\n    description: 'Fetch entity by reference',\n    example: yaml.stringify({\n      steps: [\n        {\n          action: 'catalog:fetch',\n          id: 'fetch',\n          name: 'Fetch catalog entity',\n          input: {\n            entityRef: 'component:default/name',\n          },\n        },\n      ],\n    }),\n  },\n  {\n    description: 'Fetch multiple entities by reference',\n    example: yaml.stringify({\n      steps: [\n        {\n          action: 'catalog:fetch',\n          id: 'fetchMultiple',\n          name: 'Fetch catalog entities',\n          input: {\n            entityRefs: ['component:default/name'],\n          },\n        },\n      ],\n    }),\n  },\n];\n"],"names":["yaml"],"mappings":";;;;;;;;AAmBO,MAAM,QAA8B,GAAA;AAAA,EACzC;AAAA,IACE,WAAa,EAAA,2BAAA;AAAA,IACb,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,MAAQ,EAAA,eAAA;AAAA,UACR,EAAI,EAAA,OAAA;AAAA,UACJ,IAAM,EAAA,sBAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,SAAW,EAAA,wBAAA;AAAA,WACb;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AAAA,EACA;AAAA,IACE,WAAa,EAAA,sCAAA;AAAA,IACb,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,MAAQ,EAAA,eAAA;AAAA,UACR,EAAI,EAAA,eAAA;AAAA,UACJ,IAAM,EAAA,wBAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,UAAA,EAAY,CAAC,wBAAwB,CAAA;AAAA,WACvC;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AACF;;;;"}

package/dist/scaffolder/actions/builtin/catalog/register.cjs.js

@@ -0,0 +1,142 @@
+'use strict';
+
+var errors = require('@backstage/errors');
+var catalogModel = require('@backstage/catalog-model');
+var pluginScaffolderNode = require('@backstage/plugin-scaffolder-node');
+var register_examples = require('./register.examples.cjs.js');
+
+const id = "catalog:register";
+function createCatalogRegisterAction(options) {
+  const { catalogClient, integrations, auth } = options;
+  return pluginScaffolderNode.createTemplateAction({
+    id,
+    description: "Registers entities from a catalog descriptor file in the workspace into the software catalog.",
+    examples: register_examples.examples,
+    schema: {
+      input: {
+        oneOf: [
+          {
+            type: "object",
+            required: ["catalogInfoUrl"],
+            properties: {
+              catalogInfoUrl: {
+                title: "Catalog Info URL",
+                description: "An absolute URL pointing to the catalog info file location",
+                type: "string"
+              },
+              optional: {
+                title: "Optional",
+                description: "Permit the registered location to optionally exist. Default: false",
+                type: "boolean"
+              }
+            }
+          },
+          {
+            type: "object",
+            required: ["repoContentsUrl"],
+            properties: {
+              repoContentsUrl: {
+                title: "Repository Contents URL",
+                description: "An absolute URL pointing to the root of a repository directory tree",
+                type: "string"
+              },
+              catalogInfoPath: {
+                title: "Fetch URL",
+                description: "A relative path from the repo root pointing to the catalog info file, defaults to /catalog-info.yaml",
+                type: "string"
+              },
+              optional: {
+                title: "Optional",
+                description: "Permit the registered location to optionally exist. Default: false",
+                type: "boolean"
+              }
+            }
+          }
+        ]
+      },
+      output: {
+        type: "object",
+        required: ["catalogInfoUrl"],
+        properties: {
+          entityRef: {
+            type: "string"
+          },
+          catalogInfoUrl: {
+            type: "string"
+          }
+        }
+      }
+    },
+    async handler(ctx) {
+      const { input } = ctx;
+      let catalogInfoUrl;
+      if ("catalogInfoUrl" in input) {
+        catalogInfoUrl = input.catalogInfoUrl;
+      } else {
+        const { repoContentsUrl, catalogInfoPath = "/catalog-info.yaml" } = input;
+        const integration = integrations.byUrl(repoContentsUrl);
+        if (!integration) {
+          throw new errors.InputError(
+            `No integration found for host ${repoContentsUrl}`
+          );
+        }
+        catalogInfoUrl = integration.resolveUrl({
+          base: repoContentsUrl,
+          url: catalogInfoPath
+        });
+      }
+      ctx.logger.info(`Registering ${catalogInfoUrl} in the catalog`);
+      const { token } = await auth?.getPluginRequestToken({
+        onBehalfOf: await ctx.getInitiatorCredentials(),
+        targetPluginId: "catalog"
+      }) ?? { token: ctx.secrets?.backstageToken };
+      try {
+        await catalogClient.addLocation(
+          {
+            type: "url",
+            target: catalogInfoUrl
+          },
+          token ? { token } : {}
+        );
+      } catch (e) {
+        if (!input.optional) {
+          throw e;
+        }
+      }
+      try {
+        const result = await catalogClient.addLocation(
+          {
+            dryRun: true,
+            type: "url",
+            target: catalogInfoUrl
+          },
+          token ? { token } : {}
+        );
+        if (result.entities.length) {
+          const { entities } = result;
+          let entity;
+          entity = entities.find(
+            (e) => !e.metadata.name.startsWith("generated-") && e.kind === "Component"
+          );
+          if (!entity) {
+            entity = entities.find(
+              (e) => !e.metadata.name.startsWith("generated-")
+            );
+          }
+          if (!entity) {
+            entity = entities[0];
+          }
+          ctx.output("entityRef", catalogModel.stringifyEntityRef(entity));
+        }
+      } catch (e) {
+        if (!input.optional) {
+          throw e;
+        }
+      }
+      ctx.output("catalogInfoUrl", catalogInfoUrl);
+    }
+  });
+}
+
+exports.createCatalogRegisterAction = createCatalogRegisterAction;
+//# sourceMappingURL=register.cjs.js.map

package/dist/scaffolder/actions/builtin/catalog/register.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"register.cjs.js","sources":["../../../../../src/scaffolder/actions/builtin/catalog/register.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 { InputError } from '@backstage/errors';\nimport { ScmIntegrations } from '@backstage/integration';\nimport { CatalogApi } from '@backstage/catalog-client';\nimport { stringifyEntityRef, Entity } from '@backstage/catalog-model';\nimport { createTemplateAction } from '@backstage/plugin-scaffolder-node';\nimport { examples } from './register.examples';\nimport { AuthService } from '@backstage/backend-plugin-api';\n\nconst id = 'catalog:register';\n\n/**\n * Registers entities from a catalog descriptor file in the workspace into the software catalog.\n * @public\n */\nexport function createCatalogRegisterAction(options: {\n  catalogClient: CatalogApi;\n  integrations: ScmIntegrations;\n  auth?: AuthService;\n}) {\n  const { catalogClient, integrations, auth } = options;\n\n  return createTemplateAction<\n    | { catalogInfoUrl: string; optional?: boolean }\n    | { repoContentsUrl: string; catalogInfoPath?: string; optional?: boolean }\n  >({\n    id,\n    description:\n      'Registers entities from a catalog descriptor file in the workspace into the software catalog.',\n    examples,\n    schema: {\n      input: {\n        oneOf: [\n          {\n            type: 'object',\n            required: ['catalogInfoUrl'],\n            properties: {\n              catalogInfoUrl: {\n                title: 'Catalog Info URL',\n                description:\n                  'An absolute URL pointing to the catalog info file location',\n                type: 'string',\n              },\n              optional: {\n                title: 'Optional',\n                description:\n                  'Permit the registered location to optionally exist. Default: false',\n                type: 'boolean',\n              },\n            },\n          },\n          {\n            type: 'object',\n            required: ['repoContentsUrl'],\n            properties: {\n              repoContentsUrl: {\n                title: 'Repository Contents URL',\n                description:\n                  'An absolute URL pointing to the root of a repository directory tree',\n                type: 'string',\n              },\n              catalogInfoPath: {\n                title: 'Fetch URL',\n                description:\n                  'A relative path from the repo root pointing to the catalog info file, defaults to /catalog-info.yaml',\n                type: 'string',\n              },\n              optional: {\n                title: 'Optional',\n                description:\n                  'Permit the registered location to optionally exist. Default: false',\n                type: 'boolean',\n              },\n            },\n          },\n        ],\n      },\n      output: {\n        type: 'object',\n        required: ['catalogInfoUrl'],\n        properties: {\n          entityRef: {\n            type: 'string',\n          },\n          catalogInfoUrl: {\n            type: 'string',\n          },\n        },\n      },\n    },\n    async handler(ctx) {\n      const { input } = ctx;\n\n      let catalogInfoUrl;\n      if ('catalogInfoUrl' in input) {\n        catalogInfoUrl = input.catalogInfoUrl;\n      } else {\n        const { repoContentsUrl, catalogInfoPath = '/catalog-info.yaml' } =\n          input;\n        const integration = integrations.byUrl(repoContentsUrl);\n        if (!integration) {\n          throw new InputError(\n            `No integration found for host ${repoContentsUrl}`,\n          );\n        }\n\n        catalogInfoUrl = integration.resolveUrl({\n          base: repoContentsUrl,\n          url: catalogInfoPath,\n        });\n      }\n\n      ctx.logger.info(`Registering ${catalogInfoUrl} in the catalog`);\n\n      const { token } = (await auth?.getPluginRequestToken({\n        onBehalfOf: await ctx.getInitiatorCredentials(),\n        targetPluginId: 'catalog',\n      })) ?? { token: ctx.secrets?.backstageToken };\n\n      try {\n        // 1st try to register the location, this will throw an error if the location already exists (see catch)\n        await catalogClient.addLocation(\n          {\n            type: 'url',\n            target: catalogInfoUrl,\n          },\n          token ? { token } : {},\n        );\n      } catch (e) {\n        if (!input.optional) {\n          // if optional is false or unset, it is not allowed to register the same location twice, we rethrow the error\n          throw e;\n        }\n      }\n\n      try {\n        // 2nd retry the registration as a dry run, this will not throw an error if the location already exists\n        const result = await catalogClient.addLocation(\n          {\n            dryRun: true,\n            type: 'url',\n            target: catalogInfoUrl,\n          },\n          token ? { token } : {},\n        );\n\n        if (result.entities.length) {\n          const { entities } = result;\n          let entity: Entity | undefined;\n          // prioritise 'Component' type as it is the most central kind of entity\n          entity = entities.find(\n            e =>\n              !e.metadata.name.startsWith('generated-') &&\n              e.kind === 'Component',\n          );\n          if (!entity) {\n            entity = entities.find(\n              e => !e.metadata.name.startsWith('generated-'),\n            );\n          }\n          if (!entity) {\n            entity = entities[0];\n          }\n\n          ctx.output('entityRef', stringifyEntityRef(entity));\n        }\n      } catch (e) {\n        if (!input.optional) {\n          throw e;\n        }\n      }\n\n      ctx.output('catalogInfoUrl', catalogInfoUrl);\n    },\n  });\n}\n"],"names":["createTemplateAction","examples","InputError","stringifyEntityRef"],"mappings":";;;;;;;AAwBA,MAAM,EAAK,GAAA,kBAAA,CAAA;AAMJ,SAAS,4BAA4B,OAIzC,EAAA;AACD,EAAA,MAAM,EAAE,aAAA,EAAe,YAAc,EAAA,IAAA,EAAS,GAAA,OAAA,CAAA;AAE9C,EAAA,OAAOA,yCAGL,CAAA;AAAA,IACA,EAAA;AAAA,IACA,WACE,EAAA,+FAAA;AAAA,cACFC,0BAAA;AAAA,IACA,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,KAAO,EAAA;AAAA,UACL;AAAA,YACE,IAAM,EAAA,QAAA;AAAA,YACN,QAAA,EAAU,CAAC,gBAAgB,CAAA;AAAA,YAC3B,UAAY,EAAA;AAAA,cACV,cAAgB,EAAA;AAAA,gBACd,KAAO,EAAA,kBAAA;AAAA,gBACP,WACE,EAAA,4DAAA;AAAA,gBACF,IAAM,EAAA,QAAA;AAAA,eACR;AAAA,cACA,QAAU,EAAA;AAAA,gBACR,KAAO,EAAA,UAAA;AAAA,gBACP,WACE,EAAA,oEAAA;AAAA,gBACF,IAAM,EAAA,SAAA;AAAA,eACR;AAAA,aACF;AAAA,WACF;AAAA,UACA;AAAA,YACE,IAAM,EAAA,QAAA;AAAA,YACN,QAAA,EAAU,CAAC,iBAAiB,CAAA;AAAA,YAC5B,UAAY,EAAA;AAAA,cACV,eAAiB,EAAA;AAAA,gBACf,KAAO,EAAA,yBAAA;AAAA,gBACP,WACE,EAAA,qEAAA;AAAA,gBACF,IAAM,EAAA,QAAA;AAAA,eACR;AAAA,cACA,eAAiB,EAAA;AAAA,gBACf,KAAO,EAAA,WAAA;AAAA,gBACP,WACE,EAAA,sGAAA;AAAA,gBACF,IAAM,EAAA,QAAA;AAAA,eACR;AAAA,cACA,QAAU,EAAA;AAAA,gBACR,KAAO,EAAA,UAAA;AAAA,gBACP,WACE,EAAA,oEAAA;AAAA,gBACF,IAAM,EAAA,SAAA;AAAA,eACR;AAAA,aACF;AAAA,WACF;AAAA,SACF;AAAA,OACF;AAAA,MACA,MAAQ,EAAA;AAAA,QACN,IAAM,EAAA,QAAA;AAAA,QACN,QAAA,EAAU,CAAC,gBAAgB,CAAA;AAAA,QAC3B,UAAY,EAAA;AAAA,UACV,SAAW,EAAA;AAAA,YACT,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,UACA,cAAgB,EAAA;AAAA,YACd,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,SACF;AAAA,OACF;AAAA,KACF;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAM,MAAA,EAAE,OAAU,GAAA,GAAA,CAAA;AAElB,MAAI,IAAA,cAAA,CAAA;AACJ,MAAA,IAAI,oBAAoB,KAAO,EAAA;AAC7B,QAAA,cAAA,GAAiB,KAAM,CAAA,cAAA,CAAA;AAAA,OAClB,MAAA;AACL,QAAA,MAAM,EAAE,eAAA,EAAiB,eAAkB,GAAA,oBAAA,EACzC,GAAA,KAAA,CAAA;AACF,QAAM,MAAA,WAAA,GAAc,YAAa,CAAA,KAAA,CAAM,eAAe,CAAA,CAAA;AACtD,QAAA,IAAI,CAAC,WAAa,EAAA;AAChB,UAAA,MAAM,IAAIC,iBAAA;AAAA,YACR,iCAAiC,eAAe,CAAA,CAAA;AAAA,WAClD,CAAA;AAAA,SACF;AAEA,QAAA,cAAA,GAAiB,YAAY,UAAW,CAAA;AAAA,UACtC,IAAM,EAAA,eAAA;AAAA,UACN,GAAK,EAAA,eAAA;AAAA,SACN,CAAA,CAAA;AAAA,OACH;AAEA,MAAA,GAAA,CAAI,MAAO,CAAA,IAAA,CAAK,CAAe,YAAA,EAAA,cAAc,CAAiB,eAAA,CAAA,CAAA,CAAA;AAE9D,MAAA,MAAM,EAAE,KAAA,EAAW,GAAA,MAAM,MAAM,qBAAsB,CAAA;AAAA,QACnD,UAAA,EAAY,MAAM,GAAA,CAAI,uBAAwB,EAAA;AAAA,QAC9C,cAAgB,EAAA,SAAA;AAAA,OACjB,CAAM,IAAA,EAAE,KAAO,EAAA,GAAA,CAAI,SAAS,cAAe,EAAA,CAAA;AAE5C,MAAI,IAAA;AAEF,QAAA,MAAM,aAAc,CAAA,WAAA;AAAA,UAClB;AAAA,YACE,IAAM,EAAA,KAAA;AAAA,YACN,MAAQ,EAAA,cAAA;AAAA,WACV;AAAA,UACA,KAAQ,GAAA,EAAE,KAAM,EAAA,GAAI,EAAC;AAAA,SACvB,CAAA;AAAA,eACO,CAAG,EAAA;AACV,QAAI,IAAA,CAAC,MAAM,QAAU,EAAA;AAEnB,UAAM,MAAA,CAAA,CAAA;AAAA,SACR;AAAA,OACF;AAEA,MAAI,IAAA;AAEF,QAAM,MAAA,MAAA,GAAS,MAAM,aAAc,CAAA,WAAA;AAAA,UACjC;AAAA,YACE,MAAQ,EAAA,IAAA;AAAA,YACR,IAAM,EAAA,KAAA;AAAA,YACN,MAAQ,EAAA,cAAA;AAAA,WACV;AAAA,UACA,KAAQ,GAAA,EAAE,KAAM,EAAA,GAAI,EAAC;AAAA,SACvB,CAAA;AAEA,QAAI,IAAA,MAAA,CAAO,SAAS,MAAQ,EAAA;AAC1B,UAAM,MAAA,EAAE,UAAa,GAAA,MAAA,CAAA;AACrB,UAAI,IAAA,MAAA,CAAA;AAEJ,UAAA,MAAA,GAAS,QAAS,CAAA,IAAA;AAAA,YAChB,CAAA,CAAA,KACE,CAAC,CAAE,CAAA,QAAA,CAAS,KAAK,UAAW,CAAA,YAAY,CACxC,IAAA,CAAA,CAAE,IAAS,KAAA,WAAA;AAAA,WACf,CAAA;AACA,UAAA,IAAI,CAAC,MAAQ,EAAA;AACX,YAAA,MAAA,GAAS,QAAS,CAAA,IAAA;AAAA,cAChB,OAAK,CAAC,CAAA,CAAE,QAAS,CAAA,IAAA,CAAK,WAAW,YAAY,CAAA;AAAA,aAC/C,CAAA;AAAA,WACF;AACA,UAAA,IAAI,CAAC,MAAQ,EAAA;AACX,YAAA,MAAA,GAAS,SAAS,CAAC,CAAA,CAAA;AAAA,WACrB;AAEA,UAAA,GAAA,CAAI,MAAO,CAAA,WAAA,EAAaC,+BAAmB,CAAA,MAAM,CAAC,CAAA,CAAA;AAAA,SACpD;AAAA,eACO,CAAG,EAAA;AACV,QAAI,IAAA,CAAC,MAAM,QAAU,EAAA;AACnB,UAAM,MAAA,CAAA,CAAA;AAAA,SACR;AAAA,OACF;AAEA,MAAI,GAAA,CAAA,MAAA,CAAO,kBAAkB,cAAc,CAAA,CAAA;AAAA,KAC7C;AAAA,GACD,CAAA,CAAA;AACH;;;;"}

package/dist/scaffolder/actions/builtin/catalog/register.examples.cjs.js

@@ -0,0 +1,28 @@
+'use strict';
+
+var yaml = require('yaml');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var yaml__default = /*#__PURE__*/_interopDefaultCompat(yaml);
+
+const examples = [
+  {
+    description: "Register with the catalog",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          action: "catalog:register",
+          id: "register-with-catalog",
+          name: "Register with the catalog",
+          input: {
+            catalogInfoUrl: "http://github.com/backstage/backstage/blob/master/catalog-info.yaml"
+          }
+        }
+      ]
+    })
+  }
+];
+
+exports.examples = examples;
+//# sourceMappingURL=register.examples.cjs.js.map

package/dist/scaffolder/actions/builtin/catalog/register.examples.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"register.examples.cjs.js","sources":["../../../../../src/scaffolder/actions/builtin/catalog/register.examples.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 { TemplateExample } from '@backstage/plugin-scaffolder-node';\nimport yaml from 'yaml';\n\nexport const examples: TemplateExample[] = [\n  {\n    description: 'Register with the catalog',\n    example: yaml.stringify({\n      steps: [\n        {\n          action: 'catalog:register',\n          id: 'register-with-catalog',\n          name: 'Register with the catalog',\n          input: {\n            catalogInfoUrl:\n              'http://github.com/backstage/backstage/blob/master/catalog-info.yaml',\n          },\n        },\n      ],\n    }),\n  },\n];\n"],"names":["yaml"],"mappings":";;;;;;;;AAmBO,MAAM,QAA8B,GAAA;AAAA,EACzC;AAAA,IACE,WAAa,EAAA,2BAAA;AAAA,IACb,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,MAAQ,EAAA,kBAAA;AAAA,UACR,EAAI,EAAA,uBAAA;AAAA,UACJ,IAAM,EAAA,2BAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,cACE,EAAA,qEAAA;AAAA,WACJ;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AACF;;;;"}

package/dist/scaffolder/actions/builtin/catalog/write.cjs.js

@@ -0,0 +1,74 @@
+'use strict';
+
+var fs = require('fs-extra');
+var pluginScaffolderNode = require('@backstage/plugin-scaffolder-node');
+var yaml = require('yaml');
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var zod = require('zod');
+var write_examples = require('./write.examples.cjs.js');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+function _interopNamespaceCompat(e) {
+  if (e && typeof e === 'object' && 'default' in e) return e;
+  var n = Object.create(null);
+  if (e) {
+    Object.keys(e).forEach(function (k) {
+      if (k !== 'default') {
+        var d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: function () { return e[k]; }
+        });
+      }
+    });
+  }
+  n.default = e;
+  return Object.freeze(n);
+}
+
+var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
+var yaml__namespace = /*#__PURE__*/_interopNamespaceCompat(yaml);
+
+const id = "catalog:write";
+function createCatalogWriteAction() {
+  return pluginScaffolderNode.createTemplateAction({
+    id,
+    description: "Writes the catalog-info.yaml for your template",
+    schema: {
+      input: zod.z.object({
+        filePath: zod.z.string().optional().describe("Defaults to catalog-info.yaml"),
+        // TODO: this should reference an zod entity validator if it existed.
+        entity: zod.z.record(zod.z.any()).describe(
+          "You can provide the same values used in the Entity schema."
+        )
+      })
+    },
+    examples: write_examples.examples,
+    supportsDryRun: true,
+    async handler(ctx) {
+      const { filePath, entity } = ctx.input;
+      const entityRef = ctx.templateInfo?.entityRef;
+      const path = filePath ?? "catalog-info.yaml";
+      ctx.logger.info(`Writing ${path}`);
+      await fs__default.default.outputFile(
+        backendPluginApi.resolveSafeChildPath(ctx.workspacePath, path),
+        yaml__namespace.stringify({
+          ...entity,
+          metadata: {
+            ...entity.metadata,
+            ...entityRef ? {
+              annotations: {
+                ...entity.metadata.annotations,
+                "backstage.io/source-template": entityRef
+              }
+            } : void 0
+          }
+        })
+      );
+    }
+  });
+}
+
+exports.createCatalogWriteAction = createCatalogWriteAction;
+//# sourceMappingURL=write.cjs.js.map

package/dist/scaffolder/actions/builtin/catalog/write.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"write.cjs.js","sources":["../../../../../src/scaffolder/actions/builtin/catalog/write.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 fs from 'fs-extra';\nimport { createTemplateAction } from '@backstage/plugin-scaffolder-node';\nimport * as yaml from 'yaml';\nimport { resolveSafeChildPath } from '@backstage/backend-plugin-api';\nimport { z } from 'zod';\nimport { examples } from './write.examples';\n\nconst id = 'catalog:write';\n\n/**\n * Writes a catalog descriptor file containing the provided entity to a path in the workspace.\n * @public\n */\n\nexport function createCatalogWriteAction() {\n  return createTemplateAction({\n    id,\n    description: 'Writes the catalog-info.yaml for your template',\n    schema: {\n      input: z.object({\n        filePath: z\n          .string()\n          .optional()\n          .describe('Defaults to catalog-info.yaml'),\n        // TODO: this should reference an zod entity validator if it existed.\n        entity: z\n          .record(z.any())\n          .describe(\n            'You can provide the same values used in the Entity schema.',\n          ),\n      }),\n    },\n    examples,\n    supportsDryRun: true,\n    async handler(ctx) {\n      const { filePath, entity } = ctx.input;\n      const entityRef = ctx.templateInfo?.entityRef;\n      const path = filePath ?? 'catalog-info.yaml';\n      ctx.logger.info(`Writing ${path}`);\n\n      await fs.outputFile(\n        resolveSafeChildPath(ctx.workspacePath, path),\n        yaml.stringify({\n          ...entity,\n          metadata: {\n            ...entity.metadata,\n            ...(entityRef\n              ? {\n                  annotations: {\n                    ...entity.metadata.annotations,\n                    'backstage.io/source-template': entityRef,\n                  },\n                }\n              : undefined),\n          },\n        }),\n      );\n    },\n  });\n}\n"],"names":["createTemplateAction","z","examples","fs","resolveSafeChildPath","yaml"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuBA,MAAM,EAAK,GAAA,eAAA,CAAA;AAOJ,SAAS,wBAA2B,GAAA;AACzC,EAAA,OAAOA,yCAAqB,CAAA;AAAA,IAC1B,EAAA;AAAA,IACA,WAAa,EAAA,gDAAA;AAAA,IACb,MAAQ,EAAA;AAAA,MACN,KAAA,EAAOC,MAAE,MAAO,CAAA;AAAA,QACd,UAAUA,KACP,CAAA,MAAA,GACA,QAAS,EAAA,CACT,SAAS,+BAA+B,CAAA;AAAA;AAAA,QAE3C,QAAQA,KACL,CAAA,MAAA,CAAOA,KAAE,CAAA,GAAA,EAAK,CACd,CAAA,QAAA;AAAA,UACC,4DAAA;AAAA,SACF;AAAA,OACH,CAAA;AAAA,KACH;AAAA,cACAC,uBAAA;AAAA,IACA,cAAgB,EAAA,IAAA;AAAA,IAChB,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAA,MAAM,EAAE,QAAA,EAAU,MAAO,EAAA,GAAI,GAAI,CAAA,KAAA,CAAA;AACjC,MAAM,MAAA,SAAA,GAAY,IAAI,YAAc,EAAA,SAAA,CAAA;AACpC,MAAA,MAAM,OAAO,QAAY,IAAA,mBAAA,CAAA;AACzB,MAAA,GAAA,CAAI,MAAO,CAAA,IAAA,CAAK,CAAW,QAAA,EAAA,IAAI,CAAE,CAAA,CAAA,CAAA;AAEjC,MAAA,MAAMC,mBAAG,CAAA,UAAA;AAAA,QACPC,qCAAA,CAAqB,GAAI,CAAA,aAAA,EAAe,IAAI,CAAA;AAAA,QAC5CC,gBAAK,SAAU,CAAA;AAAA,UACb,GAAG,MAAA;AAAA,UACH,QAAU,EAAA;AAAA,YACR,GAAG,MAAO,CAAA,QAAA;AAAA,YACV,GAAI,SACA,GAAA;AAAA,cACE,WAAa,EAAA;AAAA,gBACX,GAAG,OAAO,QAAS,CAAA,WAAA;AAAA,gBACnB,8BAAgC,EAAA,SAAA;AAAA,eAClC;AAAA,aAEF,GAAA,KAAA,CAAA;AAAA,WACN;AAAA,SACD,CAAA;AAAA,OACH,CAAA;AAAA,KACF;AAAA,GACD,CAAA,CAAA;AACH;;;;"}

package/dist/scaffolder/actions/builtin/catalog/write.examples.cjs.js

@@ -0,0 +1,56 @@
+'use strict';
+
+var yaml = require('yaml');
+
+function _interopNamespaceCompat(e) {
+  if (e && typeof e === 'object' && 'default' in e) return e;
+  var n = Object.create(null);
+  if (e) {
+    Object.keys(e).forEach(function (k) {
+      if (k !== 'default') {
+        var d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: function () { return e[k]; }
+        });
+      }
+    });
+  }
+  n.default = e;
+  return Object.freeze(n);
+}
+
+var yaml__namespace = /*#__PURE__*/_interopNamespaceCompat(yaml);
+
+const examples = [
+  {
+    description: "Write a catalog yaml file",
+    example: yaml__namespace.stringify({
+      steps: [
+        {
+          action: "catalog:write",
+          id: "create-catalog-info-file",
+          name: "Create catalog file",
+          input: {
+            entity: {
+              apiVersion: "backstage.io/v1alpha1",
+              kind: "Component",
+              metadata: {
+                name: "test",
+                annotations: {}
+              },
+              spec: {
+                type: "service",
+                lifecycle: "production",
+                owner: "default/owner"
+              }
+            }
+          }
+        }
+      ]
+    })
+  }
+];
+
+exports.examples = examples;
+//# sourceMappingURL=write.examples.cjs.js.map

package/dist/scaffolder/actions/builtin/catalog/write.examples.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"write.examples.cjs.js","sources":["../../../../../src/scaffolder/actions/builtin/catalog/write.examples.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 { TemplateExample } from '@backstage/plugin-scaffolder-node';\nimport * as yaml from 'yaml';\n\nexport const examples: TemplateExample[] = [\n  {\n    description: 'Write a catalog yaml file',\n    example: yaml.stringify({\n      steps: [\n        {\n          action: 'catalog:write',\n          id: 'create-catalog-info-file',\n          name: 'Create catalog file',\n          input: {\n            entity: {\n              apiVersion: 'backstage.io/v1alpha1',\n              kind: 'Component',\n              metadata: {\n                name: 'test',\n                annotations: {},\n              },\n              spec: {\n                type: 'service',\n                lifecycle: 'production',\n                owner: 'default/owner',\n              },\n            },\n          },\n        },\n      ],\n    }),\n  },\n];\n"],"names":["yaml"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAmBO,MAAM,QAA8B,GAAA;AAAA,EACzC;AAAA,IACE,WAAa,EAAA,2BAAA;AAAA,IACb,OAAA,EAASA,gBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,MAAQ,EAAA,eAAA;AAAA,UACR,EAAI,EAAA,0BAAA;AAAA,UACJ,IAAM,EAAA,qBAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,MAAQ,EAAA;AAAA,cACN,UAAY,EAAA,uBAAA;AAAA,cACZ,IAAM,EAAA,WAAA;AAAA,cACN,QAAU,EAAA;AAAA,gBACR,IAAM,EAAA,MAAA;AAAA,gBACN,aAAa,EAAC;AAAA,eAChB;AAAA,cACA,IAAM,EAAA;AAAA,gBACJ,IAAM,EAAA,SAAA;AAAA,gBACN,SAAW,EAAA,YAAA;AAAA,gBACX,KAAO,EAAA,eAAA;AAAA,eACT;AAAA,aACF;AAAA,WACF;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AACF;;;;"}

package/dist/scaffolder/actions/builtin/createBuiltinActions.cjs.js

@@ -0,0 +1,156 @@
+'use strict';
+
+var integration = require('@backstage/integration');
+var register = require('./catalog/register.cjs.js');
+var write = require('./catalog/write.cjs.js');
+var fetch = require('./catalog/fetch.cjs.js');
+var log = require('./debug/log.cjs.js');
+var wait = require('./debug/wait.cjs.js');
+var plain = require('./fetch/plain.cjs.js');
+var plainFile = require('./fetch/plainFile.cjs.js');
+var template = require('./fetch/template.cjs.js');
+var templateFile = require('./fetch/templateFile.cjs.js');
+var _delete = require('./filesystem/delete.cjs.js');
+var rename = require('./filesystem/rename.cjs.js');
+var github = require('@backstage/plugin-scaffolder-backend-module-github');
+var azure = require('@backstage/plugin-scaffolder-backend-module-azure');
+var bitbucket = require('@backstage/plugin-scaffolder-backend-module-bitbucket');
+var bitbucketCloud = require('@backstage/plugin-scaffolder-backend-module-bitbucket-cloud');
+var bitbucketServer = require('@backstage/plugin-scaffolder-backend-module-bitbucket-server');
+var gerrit = require('@backstage/plugin-scaffolder-backend-module-gerrit');
+var gitlab = require('@backstage/plugin-scaffolder-backend-module-gitlab');
+var pluginScaffolderBackendModuleGitea = require('@backstage/plugin-scaffolder-backend-module-gitea');
+
+const createBuiltinActions = (options) => {
+  const {
+    reader,
+    integrations,
+    catalogClient,
+    auth,
+    config,
+    additionalTemplateFilters,
+    additionalTemplateGlobals
+  } = options;
+  const githubCredentialsProvider = integration.DefaultGithubCredentialsProvider.fromIntegrations(integrations);
+  const actions = [
+    plain.createFetchPlainAction({
+      reader,
+      integrations
+    }),
+    plainFile.createFetchPlainFileAction({
+      reader,
+      integrations
+    }),
+    template.createFetchTemplateAction({
+      integrations,
+      reader,
+      additionalTemplateFilters,
+      additionalTemplateGlobals
+    }),
+    templateFile.createFetchTemplateFileAction({
+      integrations,
+      reader,
+      additionalTemplateFilters,
+      additionalTemplateGlobals
+    }),
+    gerrit.createPublishGerritAction({
+      integrations,
+      config
+    }),
+    gerrit.createPublishGerritReviewAction({
+      integrations,
+      config
+    }),
+    pluginScaffolderBackendModuleGitea.createPublishGiteaAction({
+      integrations,
+      config
+    }),
+    github.createPublishGithubAction({
+      integrations,
+      config,
+      githubCredentialsProvider
+    }),
+    github.createPublishGithubPullRequestAction({
+      integrations,
+      githubCredentialsProvider,
+      config
+    }),
+    gitlab.createPublishGitlabAction({
+      integrations,
+      config
+    }),
+    gitlab.createPublishGitlabMergeRequestAction({
+      integrations
+    }),
+    gitlab.createGitlabRepoPushAction({
+      integrations
+    }),
+    bitbucket.createPublishBitbucketAction({
+      integrations,
+      config
+    }),
+    bitbucketCloud.createPublishBitbucketCloudAction({
+      integrations,
+      config
+    }),
+    bitbucketCloud.createPublishBitbucketCloudPullRequestAction({ integrations, config }),
+    bitbucketServer.createPublishBitbucketServerAction({
+      integrations,
+      config
+    }),
+    bitbucketServer.createPublishBitbucketServerPullRequestAction({
+      integrations,
+      config
+    }),
+    azure.createPublishAzureAction({
+      integrations,
+      config
+    }),
+    log.createDebugLogAction(),
+    wait.createWaitAction(),
+    register.createCatalogRegisterAction({ catalogClient, integrations, auth }),
+    fetch.createFetchCatalogEntityAction({ catalogClient, auth }),
+    write.createCatalogWriteAction(),
+    _delete.createFilesystemDeleteAction(),
+    rename.createFilesystemRenameAction(),
+    github.createGithubActionsDispatchAction({
+      integrations,
+      githubCredentialsProvider
+    }),
+    github.createGithubWebhookAction({
+      integrations,
+      githubCredentialsProvider
+    }),
+    github.createGithubIssuesLabelAction({
+      integrations,
+      githubCredentialsProvider
+    }),
+    github.createGithubRepoCreateAction({
+      integrations,
+      githubCredentialsProvider
+    }),
+    github.createGithubRepoPushAction({
+      integrations,
+      config,
+      githubCredentialsProvider
+    }),
+    github.createGithubEnvironmentAction({
+      integrations,
+      catalogClient
+    }),
+    github.createGithubDeployKeyAction({
+      integrations
+    }),
+    github.createGithubAutolinksAction({
+      integrations,
+      githubCredentialsProvider
+    }),
+    bitbucketCloud.createBitbucketPipelinesRunAction({
+      integrations
+    })
+  ];
+  return actions;
+};
+
+exports.createBuiltinActions = createBuiltinActions;
+//# sourceMappingURL=createBuiltinActions.cjs.js.map

package/dist/scaffolder/actions/builtin/createBuiltinActions.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createBuiltinActions.cjs.js","sources":["../../../../src/scaffolder/actions/builtin/createBuiltinActions.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 { CatalogApi } from '@backstage/catalog-client';\nimport { Config } from '@backstage/config';\nimport {\n  DefaultGithubCredentialsProvider,\n  GithubCredentialsProvider,\n  ScmIntegrations,\n} from '@backstage/integration';\nimport {\n  TemplateAction,\n  TemplateFilter,\n  TemplateGlobal,\n} from '@backstage/plugin-scaffolder-node';\nimport {\n  createCatalogRegisterAction,\n  createCatalogWriteAction,\n  createFetchCatalogEntityAction,\n} from './catalog';\n\nimport { createDebugLogAction, createWaitAction } from './debug';\nimport {\n  createFetchPlainAction,\n  createFetchPlainFileAction,\n  createFetchTemplateAction,\n  createFetchTemplateFileAction,\n} from './fetch';\nimport {\n  createFilesystemDeleteAction,\n  createFilesystemRenameAction,\n} from './filesystem';\nimport {\n  createGithubActionsDispatchAction,\n  createGithubAutolinksAction,\n  createGithubDeployKeyAction,\n  createGithubEnvironmentAction,\n  createGithubIssuesLabelAction,\n  createGithubRepoCreateAction,\n  createGithubRepoPushAction,\n  createGithubWebhookAction,\n  createPublishGithubAction,\n  createPublishGithubPullRequestAction,\n} from '@backstage/plugin-scaffolder-backend-module-github';\n\nimport { createPublishAzureAction } from '@backstage/plugin-scaffolder-backend-module-azure';\n\nimport { createPublishBitbucketAction } from '@backstage/plugin-scaffolder-backend-module-bitbucket';\n\nimport {\n  createPublishBitbucketCloudAction,\n  createBitbucketPipelinesRunAction,\n  createPublishBitbucketCloudPullRequestAction,\n} from '@backstage/plugin-scaffolder-backend-module-bitbucket-cloud';\n\nimport {\n  createPublishBitbucketServerAction,\n  createPublishBitbucketServerPullRequestAction,\n} from '@backstage/plugin-scaffolder-backend-module-bitbucket-server';\n\nimport {\n  createPublishGerritAction,\n  createPublishGerritReviewAction,\n} from '@backstage/plugin-scaffolder-backend-module-gerrit';\n\nimport {\n  createPublishGitlabAction,\n  createGitlabRepoPushAction,\n  createPublishGitlabMergeRequestAction,\n} from '@backstage/plugin-scaffolder-backend-module-gitlab';\n\nimport { createPublishGiteaAction } from '@backstage/plugin-scaffolder-backend-module-gitea';\nimport { AuthService, UrlReaderService } from '@backstage/backend-plugin-api';\n\n/**\n * The options passed to {@link createBuiltinActions}\n * @public\n */\nexport interface CreateBuiltInActionsOptions {\n  /**\n   * The {@link @backstage/backend-plugin-api#UrlReaderService} interface that will be used in the default actions.\n   */\n  reader: UrlReaderService;\n  /**\n   * The {@link @backstage/integrations#ScmIntegrations} that will be used in the default actions.\n   */\n  integrations: ScmIntegrations;\n  /**\n   * The {@link @backstage/catalog-client#CatalogApi} that will be used in the default actions.\n   */\n  catalogClient: CatalogApi;\n  /**\n   * The {@link @backstage/backend-plugin-api#AuthService} that will be used in the default actions.\n   */\n  auth?: AuthService;\n  /**\n   * The {@link @backstage/config#Config} that will be used in the default actions.\n   */\n  config: Config;\n  /**\n   * Additional custom filters that will be passed to the nunjucks template engine for use in\n   * Template Manifests and also template skeleton files when using `fetch:template`.\n   */\n  additionalTemplateFilters?: Record<string, TemplateFilter>;\n  additionalTemplateGlobals?: Record<string, TemplateGlobal>;\n}\n\n/**\n * A function to generate create a list of default actions that the scaffolder provides.\n * Is called internally in the default setup, but can be used when adding your own actions or overriding the default ones\n *\n * TODO(blam): version 2 of the scaffolder shouldn't ship with the additional modules. We should ship the basics, and let people install\n * modules for the providers they want to use.\n * @public\n * @returns A list of actions that can be used in the scaffolder\n *\n */\nexport const createBuiltinActions = (\n  options: CreateBuiltInActionsOptions,\n): TemplateAction[] => {\n  const {\n    reader,\n    integrations,\n    catalogClient,\n    auth,\n    config,\n    additionalTemplateFilters,\n    additionalTemplateGlobals,\n  } = options;\n\n  const githubCredentialsProvider: GithubCredentialsProvider =\n    DefaultGithubCredentialsProvider.fromIntegrations(integrations);\n\n  const actions = [\n    createFetchPlainAction({\n      reader,\n      integrations,\n    }),\n    createFetchPlainFileAction({\n      reader,\n      integrations,\n    }),\n    createFetchTemplateAction({\n      integrations,\n      reader,\n      additionalTemplateFilters,\n      additionalTemplateGlobals,\n    }),\n    createFetchTemplateFileAction({\n      integrations,\n      reader,\n      additionalTemplateFilters,\n      additionalTemplateGlobals,\n    }),\n    createPublishGerritAction({\n      integrations,\n      config,\n    }),\n    createPublishGerritReviewAction({\n      integrations,\n      config,\n    }),\n    createPublishGiteaAction({\n      integrations,\n      config,\n    }),\n    createPublishGithubAction({\n      integrations,\n      config,\n      githubCredentialsProvider,\n    }),\n    createPublishGithubPullRequestAction({\n      integrations,\n      githubCredentialsProvider,\n      config,\n    }),\n    createPublishGitlabAction({\n      integrations,\n      config,\n    }),\n    createPublishGitlabMergeRequestAction({\n      integrations,\n    }),\n    createGitlabRepoPushAction({\n      integrations,\n    }),\n    createPublishBitbucketAction({\n      integrations,\n      config,\n    }),\n    createPublishBitbucketCloudAction({\n      integrations,\n      config,\n    }),\n    createPublishBitbucketCloudPullRequestAction({ integrations, config }),\n    createPublishBitbucketServerAction({\n      integrations,\n      config,\n    }),\n    createPublishBitbucketServerPullRequestAction({\n      integrations,\n      config,\n    }),\n    createPublishAzureAction({\n      integrations,\n      config,\n    }),\n    createDebugLogAction(),\n    createWaitAction(),\n    createCatalogRegisterAction({ catalogClient, integrations, auth }),\n    createFetchCatalogEntityAction({ catalogClient, auth }),\n    createCatalogWriteAction(),\n    createFilesystemDeleteAction(),\n    createFilesystemRenameAction(),\n    createGithubActionsDispatchAction({\n      integrations,\n      githubCredentialsProvider,\n    }),\n    createGithubWebhookAction({\n      integrations,\n      githubCredentialsProvider,\n    }),\n    createGithubIssuesLabelAction({\n      integrations,\n      githubCredentialsProvider,\n    }),\n    createGithubRepoCreateAction({\n      integrations,\n      githubCredentialsProvider,\n    }),\n    createGithubRepoPushAction({\n      integrations,\n      config,\n      githubCredentialsProvider,\n    }),\n    createGithubEnvironmentAction({\n      integrations,\n      catalogClient,\n    }),\n    createGithubDeployKeyAction({\n      integrations,\n    }),\n    createGithubAutolinksAction({\n      integrations,\n      githubCredentialsProvider,\n    }),\n    createBitbucketPipelinesRunAction({\n      integrations,\n    }),\n  ];\n\n  return actions as TemplateAction[];\n};\n"],"names":["DefaultGithubCredentialsProvider","createFetchPlainAction","createFetchPlainFileAction","createFetchTemplateAction","createFetchTemplateFileAction","createPublishGerritAction","createPublishGerritReviewAction","createPublishGiteaAction","createPublishGithubAction","createPublishGithubPullRequestAction","createPublishGitlabAction","createPublishGitlabMergeRequestAction","createGitlabRepoPushAction","createPublishBitbucketAction","createPublishBitbucketCloudAction","createPublishBitbucketCloudPullRequestAction","createPublishBitbucketServerAction","createPublishBitbucketServerPullRequestAction","createPublishAzureAction","createDebugLogAction","createWaitAction","createCatalogRegisterAction","createFetchCatalogEntityAction","createCatalogWriteAction","createFilesystemDeleteAction","createFilesystemRenameAction","createGithubActionsDispatchAction","createGithubWebhookAction","createGithubIssuesLabelAction","createGithubRepoCreateAction","createGithubRepoPushAction","createGithubEnvironmentAction","createGithubDeployKeyAction","createGithubAutolinksAction","createBitbucketPipelinesRunAction"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAkIa,MAAA,oBAAA,GAAuB,CAClC,OACqB,KAAA;AACrB,EAAM,MAAA;AAAA,IACJ,MAAA;AAAA,IACA,YAAA;AAAA,IACA,aAAA;AAAA,IACA,IAAA;AAAA,IACA,MAAA;AAAA,IACA,yBAAA;AAAA,IACA,yBAAA;AAAA,GACE,GAAA,OAAA,CAAA;AAEJ,EAAM,MAAA,yBAAA,GACJA,4CAAiC,CAAA,gBAAA,CAAiB,YAAY,CAAA,CAAA;AAEhE,EAAA,MAAM,OAAU,GAAA;AAAA,IACdC,4BAAuB,CAAA;AAAA,MACrB,MAAA;AAAA,MACA,YAAA;AAAA,KACD,CAAA;AAAA,IACDC,oCAA2B,CAAA;AAAA,MACzB,MAAA;AAAA,MACA,YAAA;AAAA,KACD,CAAA;AAAA,IACDC,kCAA0B,CAAA;AAAA,MACxB,YAAA;AAAA,MACA,MAAA;AAAA,MACA,yBAAA;AAAA,MACA,yBAAA;AAAA,KACD,CAAA;AAAA,IACDC,0CAA8B,CAAA;AAAA,MAC5B,YAAA;AAAA,MACA,MAAA;AAAA,MACA,yBAAA;AAAA,MACA,yBAAA;AAAA,KACD,CAAA;AAAA,IACDC,gCAA0B,CAAA;AAAA,MACxB,YAAA;AAAA,MACA,MAAA;AAAA,KACD,CAAA;AAAA,IACDC,sCAAgC,CAAA;AAAA,MAC9B,YAAA;AAAA,MACA,MAAA;AAAA,KACD,CAAA;AAAA,IACDC,2DAAyB,CAAA;AAAA,MACvB,YAAA;AAAA,MACA,MAAA;AAAA,KACD,CAAA;AAAA,IACDC,gCAA0B,CAAA;AAAA,MACxB,YAAA;AAAA,MACA,MAAA;AAAA,MACA,yBAAA;AAAA,KACD,CAAA;AAAA,IACDC,2CAAqC,CAAA;AAAA,MACnC,YAAA;AAAA,MACA,yBAAA;AAAA,MACA,MAAA;AAAA,KACD,CAAA;AAAA,IACDC,gCAA0B,CAAA;AAAA,MACxB,YAAA;AAAA,MACA,MAAA;AAAA,KACD,CAAA;AAAA,IACDC,4CAAsC,CAAA;AAAA,MACpC,YAAA;AAAA,KACD,CAAA;AAAA,IACDC,iCAA2B,CAAA;AAAA,MACzB,YAAA;AAAA,KACD,CAAA;AAAA,IACDC,sCAA6B,CAAA;AAAA,MAC3B,YAAA;AAAA,MACA,MAAA;AAAA,KACD,CAAA;AAAA,IACDC,gDAAkC,CAAA;AAAA,MAChC,YAAA;AAAA,MACA,MAAA;AAAA,KACD,CAAA;AAAA,IACDC,2DAA6C,CAAA,EAAE,YAAc,EAAA,MAAA,EAAQ,CAAA;AAAA,IACrEC,kDAAmC,CAAA;AAAA,MACjC,YAAA;AAAA,MACA,MAAA;AAAA,KACD,CAAA;AAAA,IACDC,6DAA8C,CAAA;AAAA,MAC5C,YAAA;AAAA,MACA,MAAA;AAAA,KACD,CAAA;AAAA,IACDC,8BAAyB,CAAA;AAAA,MACvB,YAAA;AAAA,MACA,MAAA;AAAA,KACD,CAAA;AAAA,IACDC,wBAAqB,EAAA;AAAA,IACrBC,qBAAiB,EAAA;AAAA,IACjBC,oCAA4B,CAAA,EAAE,aAAe,EAAA,YAAA,EAAc,MAAM,CAAA;AAAA,IACjEC,oCAA+B,CAAA,EAAE,aAAe,EAAA,IAAA,EAAM,CAAA;AAAA,IACtDC,8BAAyB,EAAA;AAAA,IACzBC,oCAA6B,EAAA;AAAA,IAC7BC,mCAA6B,EAAA;AAAA,IAC7BC,wCAAkC,CAAA;AAAA,MAChC,YAAA;AAAA,MACA,yBAAA;AAAA,KACD,CAAA;AAAA,IACDC,gCAA0B,CAAA;AAAA,MACxB,YAAA;AAAA,MACA,yBAAA;AAAA,KACD,CAAA;AAAA,IACDC,oCAA8B,CAAA;AAAA,MAC5B,YAAA;AAAA,MACA,yBAAA;AAAA,KACD,CAAA;AAAA,IACDC,mCAA6B,CAAA;AAAA,MAC3B,YAAA;AAAA,MACA,yBAAA;AAAA,KACD,CAAA;AAAA,IACDC,iCAA2B,CAAA;AAAA,MACzB,YAAA;AAAA,MACA,MAAA;AAAA,MACA,yBAAA;AAAA,KACD,CAAA;AAAA,IACDC,oCAA8B,CAAA;AAAA,MAC5B,YAAA;AAAA,MACA,aAAA;AAAA,KACD,CAAA;AAAA,IACDC,kCAA4B,CAAA;AAAA,MAC1B,YAAA;AAAA,KACD,CAAA;AAAA,IACDC,kCAA4B,CAAA;AAAA,MAC1B,YAAA;AAAA,MACA,yBAAA;AAAA,KACD,CAAA;AAAA,IACDC,gDAAkC,CAAA;AAAA,MAChC,YAAA;AAAA,KACD,CAAA;AAAA,GACH,CAAA;AAEA,EAAO,OAAA,OAAA,CAAA;AACT;;;;"}

package/dist/scaffolder/actions/builtin/debug/log.cjs.js

@@ -0,0 +1,66 @@
+'use strict';
+
+var fs$1 = require('fs-extra');
+var path = require('path');
+var pluginScaffolderNode = require('@backstage/plugin-scaffolder-node');
+var log_examples = require('./log.examples.cjs.js');
+var fs = require('fs');
+var zod = require('zod');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
+
+const id = "debug:log";
+function createDebugLogAction() {
+  return pluginScaffolderNode.createTemplateAction({
+    id,
+    description: "Writes a message into the log and/or lists all files in the workspace.",
+    examples: log_examples.examples,
+    schema: {
+      input: zod.z.object({
+        message: zod.z.string({ description: "Message to output." }).optional(),
+        listWorkspace: zod.z.union([zod.z.boolean(), zod.z.enum(["with-filenames", "with-contents"])], {
+          description: 'List all files in the workspace. If used with "with-contents", also the file contents are listed.'
+        }).optional()
+      })
+    },
+    supportsDryRun: true,
+    async handler(ctx) {
+      ctx.logger.info(JSON.stringify(ctx.input, null, 2));
+      if (ctx.input?.message) {
+        ctx.logger.info(ctx.input.message);
+      }
+      if (ctx.input?.listWorkspace) {
+        const files = await recursiveReadDir(ctx.workspacePath);
+        ctx.logger.info(
+          `Workspace:
+${files.map((f) => {
+            const relativePath = path.relative(ctx.workspacePath, f);
+            if (ctx.input?.listWorkspace === "with-contents") {
+              const content = fs__default.default.readFileSync(f, "utf-8");
+              return ` - ${relativePath}:
+
+  ${content}`;
+            }
+            return `  - ${relativePath}`;
+          }).join("\n")}`
+        );
+      }
+    }
+  });
+}
+async function recursiveReadDir(dir) {
+  const subdirs = await fs$1.readdir(dir);
+  const files = await Promise.all(
+    subdirs.map(async (subdir) => {
+      const res = path.join(dir, subdir);
+      return (await fs$1.stat(res)).isDirectory() ? recursiveReadDir(res) : [res];
+    })
+  );
+  return files.reduce((a, f) => a.concat(f), []);
+}
+
+exports.createDebugLogAction = createDebugLogAction;
+exports.recursiveReadDir = recursiveReadDir;
+//# sourceMappingURL=log.cjs.js.map