@techdocs/cli 1.8.12-next.3 → 1.8.13

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @techdocs/cli
 
+## 1.8.13
+
+### Patch Changes
+
+- aeae3be: Import discovery from backend-defaults instead of backend-common
+- Updated dependencies
+  - @backstage/backend-defaults@0.3.1
+  - @backstage/plugin-techdocs-node@1.12.6
+  - @backstage/catalog-model@1.5.0
+  - @backstage/cli-common@0.1.14
+  - @backstage/config@1.2.0
+
+## 1.8.12
+
+### Patch Changes
+
+- 2110d76: Removed `dockerode` dependency.
+- Updated dependencies
+  - @backstage/backend-common@0.23.0
+  - @backstage/plugin-techdocs-node@1.12.5
+  - @backstage/cli-common@0.1.14
+  - @backstage/catalog-model@1.5.0
+  - @backstage/config@1.2.0
+
 ## 1.8.12-next.3
 
 ### Patch Changes

package/dist/cjs/{generate-ZiP9GGnN.cjs.js → generate-CHbYjdPP.cjs.js}

@@ -2,9 +2,7 @@
 
 var path = require('path');
 var fs = require('fs-extra');
-var Docker = require('dockerode');
 var pluginTechdocsNode = require('@backstage/plugin-techdocs-node');
-var backendCommon = require('@backstage/backend-common');
 var config = require('@backstage/config');
 var utility = require('./utility-CsspJYjU.cjs.js');
 require('winston');
@@ -14,7 +12,6 @@ require('process');
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
 var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
-var Docker__default = /*#__PURE__*/_interopDefaultCompat(Docker);
 
 async function generate(opts) {
   const logger = utility.createLogger({ verbose: opts.verbose });
@@ -46,11 +43,6 @@ async function generate(opts) {
       }
     }
   });
-  let containerRunner;
-  if (opts.docker) {
-    const dockerClient = new Docker__default.default();
-    containerRunner = new backendCommon.DockerContainerRunner({ dockerClient });
-  }
   let parsedLocationAnnotation = {};
   if (opts.techdocsRef) {
     try {
@@ -62,8 +54,7 @@ async function generate(opts) {
     }
   }
   const techdocsGenerator = await pluginTechdocsNode.TechdocsGenerator.fromConfig(config$1, {
-    logger,
-    containerRunner
+    logger
   });
   logger.info("Generating documentation...");
   await techdocsGenerator.run({
@@ -87,4 +78,4 @@ async function generate(opts) {
 }
 
 exports.default = generate;
-//# sourceMappingURL=generate-ZiP9GGnN.cjs.js.map
+//# sourceMappingURL=generate-CHbYjdPP.cjs.js.map

package/dist/cjs/generate-CHbYjdPP.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-CHbYjdPP.cjs.js","sources":["../../src/commands/generate/generate.ts"],"sourcesContent":["/*\n * Copyright 2020 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 { resolve } from 'path';\nimport { OptionValues } from 'commander';\nimport fs from 'fs-extra';\nimport {\n  TechdocsGenerator,\n  ParsedLocationAnnotation,\n  getMkdocsYml,\n} from '@backstage/plugin-techdocs-node';\nimport { ConfigReader } from '@backstage/config';\nimport {\n  convertTechDocsRefToLocationAnnotation,\n  createLogger,\n  getLogStream,\n} from '../../lib/utility';\n\nexport default async function generate(opts: OptionValues) {\n  // Use techdocs-node package to generate docs. Keep consistency between Backstage and CI generating docs.\n  // Docs can be prepared using actions/checkout or git clone, or similar paradigms on CI. The TechDocs CI workflow\n  // will run on the CI pipeline containing the documentation files.\n\n  const logger = createLogger({ verbose: opts.verbose });\n\n  const sourceDir = resolve(opts.sourceDir);\n  const outputDir = resolve(opts.outputDir);\n  const omitTechdocsCorePlugin = opts.omitTechdocsCoreMkdocsPlugin;\n  const dockerImage = opts.dockerImage;\n  const pullImage = opts.pull;\n  const legacyCopyReadmeMdToIndexMd = opts.legacyCopyReadmeMdToIndexMd;\n  const defaultPlugins = opts.defaultPlugin;\n\n  logger.info(`Using source dir ${sourceDir}`);\n  logger.info(`Will output generated files in ${outputDir}`);\n\n  logger.verbose('Creating output directory if it does not exist.');\n\n  await fs.ensureDir(outputDir);\n\n  const { path: mkdocsYmlPath, configIsTemporary } = await getMkdocsYml(\n    sourceDir,\n  );\n\n  const config = new ConfigReader({\n    techdocs: {\n      generator: {\n        runIn: opts.docker ? 'docker' : 'local',\n        dockerImage,\n        pullImage,\n        mkdocs: {\n          legacyCopyReadmeMdToIndexMd,\n          omitTechdocsCorePlugin,\n          defaultPlugins,\n        },\n      },\n    },\n  });\n\n  let parsedLocationAnnotation = {} as ParsedLocationAnnotation;\n  if (opts.techdocsRef) {\n    try {\n      parsedLocationAnnotation = convertTechDocsRefToLocationAnnotation(\n        opts.techdocsRef,\n      );\n    } catch (err) {\n      logger.error(err.message);\n    }\n  }\n\n  // Generate docs using @backstage/plugin-techdocs-node\n  const techdocsGenerator = await TechdocsGenerator.fromConfig(config, {\n    logger,\n  });\n\n  logger.info('Generating documentation...');\n\n  await techdocsGenerator.run({\n    inputDir: sourceDir,\n    outputDir,\n    ...(opts.techdocsRef\n      ? {\n          parsedLocationAnnotation,\n        }\n      : {}),\n    logger,\n    etag: opts.etag,\n    logStream: getLogStream(logger),\n    siteOptions: { name: opts.siteName },\n    runAsDefaultUser: opts.runAsDefaultUser,\n  });\n\n  if (configIsTemporary) {\n    process.on('exit', async () => {\n      fs.rmSync(mkdocsYmlPath, {});\n    });\n  }\n\n  logger.info('Done!');\n}\n"],"names":["createLogger","resolve","fs","getMkdocsYml","config","ConfigReader","convertTechDocsRefToLocationAnnotation","TechdocsGenerator","getLogStream"],"mappings":";;;;;;;;;;;;;;;AA+BA,eAA8B,SAAS,IAAoB,EAAA;AAKzD,EAAA,MAAM,SAASA,oBAAa,CAAA,EAAE,OAAS,EAAA,IAAA,CAAK,SAAS,CAAA,CAAA;AAErD,EAAM,MAAA,SAAA,GAAYC,YAAQ,CAAA,IAAA,CAAK,SAAS,CAAA,CAAA;AACxC,EAAM,MAAA,SAAA,GAAYA,YAAQ,CAAA,IAAA,CAAK,SAAS,CAAA,CAAA;AACxC,EAAA,MAAM,yBAAyB,IAAK,CAAA,4BAAA,CAAA;AACpC,EAAA,MAAM,cAAc,IAAK,CAAA,WAAA,CAAA;AACzB,EAAA,MAAM,YAAY,IAAK,CAAA,IAAA,CAAA;AACvB,EAAA,MAAM,8BAA8B,IAAK,CAAA,2BAAA,CAAA;AACzC,EAAA,MAAM,iBAAiB,IAAK,CAAA,aAAA,CAAA;AAE5B,EAAO,MAAA,CAAA,IAAA,CAAK,CAAoB,iBAAA,EAAA,SAAS,CAAE,CAAA,CAAA,CAAA;AAC3C,EAAO,MAAA,CAAA,IAAA,CAAK,CAAkC,+BAAA,EAAA,SAAS,CAAE,CAAA,CAAA,CAAA;AAEzD,EAAA,MAAA,CAAO,QAAQ,iDAAiD,CAAA,CAAA;AAEhE,EAAM,MAAAC,mBAAA,CAAG,UAAU,SAAS,CAAA,CAAA;AAE5B,EAAA,MAAM,EAAE,IAAA,EAAM,aAAe,EAAA,iBAAA,KAAsB,MAAMC,+BAAA;AAAA,IACvD,SAAA;AAAA,GACF,CAAA;AAEA,EAAM,MAAAC,QAAA,GAAS,IAAIC,mBAAa,CAAA;AAAA,IAC9B,QAAU,EAAA;AAAA,MACR,SAAW,EAAA;AAAA,QACT,KAAA,EAAO,IAAK,CAAA,MAAA,GAAS,QAAW,GAAA,OAAA;AAAA,QAChC,WAAA;AAAA,QACA,SAAA;AAAA,QACA,MAAQ,EAAA;AAAA,UACN,2BAAA;AAAA,UACA,sBAAA;AAAA,UACA,cAAA;AAAA,SACF;AAAA,OACF;AAAA,KACF;AAAA,GACD,CAAA,CAAA;AAED,EAAA,IAAI,2BAA2B,EAAC,CAAA;AAChC,EAAA,IAAI,KAAK,WAAa,EAAA;AACpB,IAAI,IAAA;AACF,MAA2B,wBAAA,GAAAC,8CAAA;AAAA,QACzB,IAAK,CAAA,WAAA;AAAA,OACP,CAAA;AAAA,aACO,GAAK,EAAA;AACZ,MAAO,MAAA,CAAA,KAAA,CAAM,IAAI,OAAO,CAAA,CAAA;AAAA,KAC1B;AAAA,GACF;AAGA,EAAA,MAAM,iBAAoB,GAAA,MAAMC,oCAAkB,CAAA,UAAA,CAAWH,QAAQ,EAAA;AAAA,IACnE,MAAA;AAAA,GACD,CAAA,CAAA;AAED,EAAA,MAAA,CAAO,KAAK,6BAA6B,CAAA,CAAA;AAEzC,EAAA,MAAM,kBAAkB,GAAI,CAAA;AAAA,IAC1B,QAAU,EAAA,SAAA;AAAA,IACV,SAAA;AAAA,IACA,GAAI,KAAK,WACL,GAAA;AAAA,MACE,wBAAA;AAAA,QAEF,EAAC;AAAA,IACL,MAAA;AAAA,IACA,MAAM,IAAK,CAAA,IAAA;AAAA,IACX,SAAA,EAAWI,qBAAa,MAAM,CAAA;AAAA,IAC9B,WAAa,EAAA,EAAE,IAAM,EAAA,IAAA,CAAK,QAAS,EAAA;AAAA,IACnC,kBAAkB,IAAK,CAAA,gBAAA;AAAA,GACxB,CAAA,CAAA;AAED,EAAA,IAAI,iBAAmB,EAAA;AACrB,IAAQ,OAAA,CAAA,EAAA,CAAG,QAAQ,YAAY;AAC7B,MAAGN,mBAAA,CAAA,MAAA,CAAO,aAAe,EAAA,EAAE,CAAA,CAAA;AAAA,KAC5B,CAAA,CAAA;AAAA,GACH;AAEA,EAAA,MAAA,CAAO,KAAK,OAAO,CAAA,CAAA;AACrB;;;;"}

package/dist/cjs/{migrate-BZzIXl_A.cjs.js → migrate-Ddd_MQkE.cjs.js}

@@ -1,6 +1,6 @@
 'use strict';
 
-var backendCommon = require('@backstage/backend-common');
+var discovery = require('@backstage/backend-defaults/discovery');
 var pluginTechdocsNode = require('@backstage/plugin-techdocs-node');
 var utility = require('./utility-CsspJYjU.cjs.js');
 var PublisherConfig = require('./PublisherConfig-Cn5i8vF5.cjs.js');
@@ -12,8 +12,8 @@ require('@backstage/config');
 async function migrate(opts) {
   const logger = utility.createLogger({ verbose: opts.verbose });
   const config = PublisherConfig.PublisherConfig.getValidConfig(opts);
-  const discovery = backendCommon.HostDiscovery.fromConfig(config);
-  const publisher = await pluginTechdocsNode.Publisher.fromConfig(config, { logger, discovery });
+  const discovery$1 = discovery.HostDiscovery.fromConfig(config);
+  const publisher = await pluginTechdocsNode.Publisher.fromConfig(config, { logger, discovery: discovery$1 });
   if (!publisher.migrateDocsCase) {
     throw new Error(`Migration not implemented for ${opts.publisherType}`);
   }
@@ -35,4 +35,4 @@ async function migrate(opts) {
 }
 
 exports.default = migrate;
-//# sourceMappingURL=migrate-BZzIXl_A.cjs.js.map
+//# sourceMappingURL=migrate-Ddd_MQkE.cjs.js.map

package/dist/cjs/migrate-Ddd_MQkE.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"migrate-Ddd_MQkE.cjs.js","sources":["../../src/commands/migrate/migrate.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 { HostDiscovery } from '@backstage/backend-defaults/discovery';\nimport { Publisher } from '@backstage/plugin-techdocs-node';\nimport { OptionValues } from 'commander';\nimport { createLogger } from '../../lib/utility';\nimport { PublisherConfig } from '../../lib/PublisherConfig';\n\nexport default async function migrate(opts: OptionValues) {\n  const logger = createLogger({ verbose: opts.verbose });\n\n  const config = PublisherConfig.getValidConfig(opts);\n  const discovery = HostDiscovery.fromConfig(config);\n  const publisher = await Publisher.fromConfig(config, { logger, discovery });\n\n  if (!publisher.migrateDocsCase) {\n    throw new Error(`Migration not implemented for ${opts.publisherType}`);\n  }\n\n  // Check that the publisher's underlying storage is ready and available.\n  const { isAvailable } = await publisher.getReadiness();\n  if (!isAvailable) {\n    // Error messages printed in getReadiness() call. This ensures exit code 1.\n    throw new Error('');\n  }\n\n  // Validate and parse migration arguments.\n  const removeOriginal = opts.removeOriginal;\n  const numericConcurrency = parseInt(opts.concurrency, 10);\n\n  if (!Number.isInteger(numericConcurrency) || numericConcurrency <= 0) {\n    throw new Error(\n      `Concurrency must be a number greater than 1. ${opts.concurrency} provided.`,\n    );\n  }\n\n  await publisher.migrateDocsCase({\n    concurrency: numericConcurrency,\n    removeOriginal,\n  });\n}\n"],"names":["createLogger","PublisherConfig","discovery","HostDiscovery","Publisher"],"mappings":";;;;;;;;;;;AAsBA,eAA8B,QAAQ,IAAoB,EAAA;AACxD,EAAA,MAAM,SAASA,oBAAa,CAAA,EAAE,OAAS,EAAA,IAAA,CAAK,SAAS,CAAA,CAAA;AAErD,EAAM,MAAA,MAAA,GAASC,+BAAgB,CAAA,cAAA,CAAe,IAAI,CAAA,CAAA;AAClD,EAAM,MAAAC,WAAA,GAAYC,uBAAc,CAAA,UAAA,CAAW,MAAM,CAAA,CAAA;AACjD,EAAM,MAAA,SAAA,GAAY,MAAMC,4BAAU,CAAA,UAAA,CAAW,QAAQ,EAAE,MAAA,aAAQF,aAAW,CAAA,CAAA;AAE1E,EAAI,IAAA,CAAC,UAAU,eAAiB,EAAA;AAC9B,IAAA,MAAM,IAAI,KAAA,CAAM,CAAiC,8BAAA,EAAA,IAAA,CAAK,aAAa,CAAE,CAAA,CAAA,CAAA;AAAA,GACvE;AAGA,EAAA,MAAM,EAAE,WAAA,EAAgB,GAAA,MAAM,UAAU,YAAa,EAAA,CAAA;AACrD,EAAA,IAAI,CAAC,WAAa,EAAA;AAEhB,IAAM,MAAA,IAAI,MAAM,EAAE,CAAA,CAAA;AAAA,GACpB;AAGA,EAAA,MAAM,iBAAiB,IAAK,CAAA,cAAA,CAAA;AAC5B,EAAA,MAAM,kBAAqB,GAAA,QAAA,CAAS,IAAK,CAAA,WAAA,EAAa,EAAE,CAAA,CAAA;AAExD,EAAA,IAAI,CAAC,MAAO,CAAA,SAAA,CAAU,kBAAkB,CAAA,IAAK,sBAAsB,CAAG,EAAA;AACpE,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,6CAAA,EAAgD,KAAK,WAAW,CAAA,UAAA,CAAA;AAAA,KAClE,CAAA;AAAA,GACF;AAEA,EAAA,MAAM,UAAU,eAAgB,CAAA;AAAA,IAC9B,WAAa,EAAA,kBAAA;AAAA,IACb,cAAA;AAAA,GACD,CAAA,CAAA;AACH;;;;"}

package/dist/cjs/{publish-CnXRqKHz.cjs.js → publish-DH7Mbt7b.cjs.js}

@@ -2,7 +2,7 @@
 
 var path = require('path');
 var utility = require('./utility-CsspJYjU.cjs.js');
-var backendCommon = require('@backstage/backend-common');
+var discovery = require('@backstage/backend-defaults/discovery');
 var pluginTechdocsNode = require('@backstage/plugin-techdocs-node');
 var PublisherConfig = require('./PublisherConfig-Cn5i8vF5.cjs.js');
 require('winston');
@@ -13,8 +13,8 @@ require('@backstage/config');
 async function publish(opts) {
   const logger = utility.createLogger({ verbose: opts.verbose });
   const config = PublisherConfig.PublisherConfig.getValidConfig(opts);
-  const discovery = backendCommon.HostDiscovery.fromConfig(config);
-  const publisher = await pluginTechdocsNode.Publisher.fromConfig(config, { logger, discovery });
+  const discovery$1 = discovery.HostDiscovery.fromConfig(config);
+  const publisher = await pluginTechdocsNode.Publisher.fromConfig(config, { logger, discovery: discovery$1 });
   const { isAvailable } = await publisher.getReadiness();
   if (!isAvailable) {
     return Promise.reject(new Error(""));
@@ -33,4 +33,4 @@ async function publish(opts) {
 }
 
 exports.default = publish;
-//# sourceMappingURL=publish-CnXRqKHz.cjs.js.map
+//# sourceMappingURL=publish-DH7Mbt7b.cjs.js.map

package/dist/cjs/publish-DH7Mbt7b.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"publish-DH7Mbt7b.cjs.js","sources":["../../src/commands/publish/publish.ts"],"sourcesContent":["/*\n * Copyright 2020 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 { resolve } from 'path';\nimport { OptionValues } from 'commander';\nimport { createLogger } from '../../lib/utility';\nimport { HostDiscovery } from '@backstage/backend-defaults/discovery';\nimport { Publisher } from '@backstage/plugin-techdocs-node';\nimport { Entity } from '@backstage/catalog-model';\nimport { PublisherConfig } from '../../lib/PublisherConfig';\n\nexport default async function publish(opts: OptionValues): Promise<any> {\n  const logger = createLogger({ verbose: opts.verbose });\n\n  const config = PublisherConfig.getValidConfig(opts);\n  const discovery = HostDiscovery.fromConfig(config);\n  const publisher = await Publisher.fromConfig(config, { logger, discovery });\n\n  // Check that the publisher's underlying storage is ready and available.\n  const { isAvailable } = await publisher.getReadiness();\n  if (!isAvailable) {\n    // Error messages printed in getReadiness() call. This ensures exit code 1.\n    return Promise.reject(new Error(''));\n  }\n\n  const [namespace, kind, name] = opts.entity.split('/');\n  const entity = {\n    kind,\n    metadata: {\n      namespace,\n      name,\n    },\n  } as Entity;\n\n  const directory = resolve(opts.directory);\n  await publisher.publish({ entity, directory });\n\n  return true;\n}\n"],"names":["createLogger","PublisherConfig","discovery","HostDiscovery","Publisher","resolve"],"mappings":";;;;;;;;;;;;AAwBA,eAA8B,QAAQ,IAAkC,EAAA;AACtE,EAAA,MAAM,SAASA,oBAAa,CAAA,EAAE,OAAS,EAAA,IAAA,CAAK,SAAS,CAAA,CAAA;AAErD,EAAM,MAAA,MAAA,GAASC,+BAAgB,CAAA,cAAA,CAAe,IAAI,CAAA,CAAA;AAClD,EAAM,MAAAC,WAAA,GAAYC,uBAAc,CAAA,UAAA,CAAW,MAAM,CAAA,CAAA;AACjD,EAAM,MAAA,SAAA,GAAY,MAAMC,4BAAU,CAAA,UAAA,CAAW,QAAQ,EAAE,MAAA,aAAQF,aAAW,CAAA,CAAA;AAG1E,EAAA,MAAM,EAAE,WAAA,EAAgB,GAAA,MAAM,UAAU,YAAa,EAAA,CAAA;AACrD,EAAA,IAAI,CAAC,WAAa,EAAA;AAEhB,IAAA,OAAO,OAAQ,CAAA,MAAA,CAAO,IAAI,KAAA,CAAM,EAAE,CAAC,CAAA,CAAA;AAAA,GACrC;AAEA,EAAM,MAAA,CAAC,WAAW,IAAM,EAAA,IAAI,IAAI,IAAK,CAAA,MAAA,CAAO,MAAM,GAAG,CAAA,CAAA;AACrD,EAAA,MAAM,MAAS,GAAA;AAAA,IACb,IAAA;AAAA,IACA,QAAU,EAAA;AAAA,MACR,SAAA;AAAA,MACA,IAAA;AAAA,KACF;AAAA,GACF,CAAA;AAEA,EAAM,MAAA,SAAA,GAAYG,YAAQ,CAAA,IAAA,CAAK,SAAS,CAAA,CAAA;AACxC,EAAA,MAAM,SAAU,CAAA,OAAA,CAAQ,EAAE,MAAA,EAAQ,WAAW,CAAA,CAAA;AAE7C,EAAO,OAAA,IAAA,CAAA;AACT;;;;"}