@backstage/plugin-techdocs-node 1.7.6 → 1.8.0-next.2

package/CHANGELOG.md

@@ -1,25 +1,43 @@
 # @backstage/plugin-techdocs-node
 
-## 1.7.6
+## 1.8.0-next.2
 
 ### Patch Changes
 
 - Updated dependencies
-  - @backstage/integration@1.6.2
-  - @backstage/backend-common@0.19.4
-  - @backstage/catalog-model@1.4.1
-  - @backstage/config@1.0.8
+  - @backstage/config@1.1.0-next.1
+  - @backstage/backend-common@0.19.5-next.2
+  - @backstage/integration@1.7.0-next.2
+  - @backstage/integration-aws-node@0.1.6-next.1
+  - @backstage/catalog-model@1.4.2-next.1
   - @backstage/errors@1.2.1
-  - @backstage/integration-aws-node@0.1.5
-  - @backstage/plugin-search-common@1.2.5
+  - @backstage/plugin-search-common@1.2.6-next.1
+
+## 1.8.0-next.1
+
+### Minor Changes
+
+- 5985d458ee30: Add a `techdocs.publisher.azureBlobStorage.connectionString` app-config setting, which can be leveraged for improved Azurite support.
+- 10a86bd4ae12: Add optional config and cli option for techdocs to specify default mkdocs plugins.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/config@1.1.0-next.0
+  - @backstage/integration@1.7.0-next.1
+  - @backstage/backend-common@0.19.5-next.1
+  - @backstage/catalog-model@1.4.2-next.0
+  - @backstage/integration-aws-node@0.1.6-next.0
+  - @backstage/errors@1.2.1
+  - @backstage/plugin-search-common@1.2.6-next.0
 
-## 1.7.5
+## 1.7.6-next.0
 
 ### Patch Changes
 
 - Updated dependencies
-  - @backstage/integration@1.6.1
-  - @backstage/backend-common@0.19.3
+  - @backstage/backend-common@0.19.4-next.0
+  - @backstage/integration@1.7.0-next.0
   - @backstage/catalog-model@1.4.1
   - @backstage/config@1.0.8
   - @backstage/errors@1.2.1

package/dist/index.cjs.js

@@ -410,14 +410,16 @@ const patchMkdocsYmlPreBuild = async (mkdocsYmlPath, logger, parsedLocationAnnot
     return false;
   });
 };
-const pathMkdocsYmlWithTechdocsPlugin = async (mkdocsYmlPath, logger) => {
+const patchMkdocsYmlWithPlugins = async (mkdocsYmlPath, logger, defaultPlugins = ["techdocs-core"]) => {
   await patchMkdocsFile(mkdocsYmlPath, logger, (mkdocsYml) => {
     if (!("plugins" in mkdocsYml)) {
-      mkdocsYml.plugins = ["techdocs-core"];
+      mkdocsYml.plugins = defaultPlugins;
       return true;
     }
-    if (mkdocsYml.plugins && !mkdocsYml.plugins.includes("techdocs-core")) {
-      mkdocsYml.plugins.push("techdocs-core");
+    if (mkdocsYml.plugins && !defaultPlugins.every((plugin) => mkdocsYml.plugins.includes(plugin))) {
+      mkdocsYml.plugins = [
+        .../* @__PURE__ */ new Set([...mkdocsYml.plugins, ...defaultPlugins])
+      ];
       return true;
     }
     return false;
@@ -458,7 +460,7 @@ const _TechdocsGenerator = class _TechdocsGenerator {
   }
   /** {@inheritDoc GeneratorBase.run} */
   async run(options) {
-    var _a;
+    var _a, _b;
     const {
       inputDir,
       outputDir,
@@ -484,9 +486,11 @@ const _TechdocsGenerator = class _TechdocsGenerator {
     if (this.options.legacyCopyReadmeMdToIndexMd) {
       await patchIndexPreBuild({ inputDir, logger: childLogger, docsDir });
     }
-    if (!this.options.omitTechdocsCoreMkdocsPlugin) {
-      await pathMkdocsYmlWithTechdocsPlugin(mkdocsYmlPath, childLogger);
+    const defaultPlugins = (_a = this.options.defaultPlugins) != null ? _a : [];
+    if (!this.options.omitTechdocsCoreMkdocsPlugin && !defaultPlugins.includes("techdocs-core")) {
+      defaultPlugins.push("techdocs-core");
     }
+    await patchMkdocsYmlWithPlugins(mkdocsYmlPath, childLogger, defaultPlugins);
     const mountDirs = {
       [inputDir]: "/input",
       [outputDir]: "/output"
@@ -513,7 +517,7 @@ const _TechdocsGenerator = class _TechdocsGenerator {
             );
           }
           await this.containerRunner.runContainer({
-            imageName: (_a = this.options.dockerImage) != null ? _a : _TechdocsGenerator.defaultDockerImage,
+            imageName: (_b = this.options.dockerImage) != null ? _b : _TechdocsGenerator.defaultDockerImage,
             args: ["build", "-d", "/output"],
             logStream,
             mountDirs,
@@ -578,6 +582,9 @@ function readGeneratorConfig(config, logger) {
     ),
     legacyCopyReadmeMdToIndexMd: config.getOptionalBoolean(
       "techdocs.generator.mkdocs.legacyCopyReadmeMdToIndexMd"
+    ),
+    defaultPlugins: config.getOptionalStringArray(
+      "techdocs.generator.mkdocs.defaultPlugins"
     )
   };
 }
@@ -1273,6 +1280,7 @@ class AzureBlobStoragePublish {
     this.logger = options.logger;
   }
   static fromConfig(config, logger) {
+    let storageClient;
     let containerName = "";
     try {
       containerName = config.getString(
@@ -1283,32 +1291,41 @@ class AzureBlobStoragePublish {
         "Since techdocs.publisher.type is set to 'azureBlobStorage' in your app config, techdocs.publisher.azureBlobStorage.containerName is required."
       );
     }
-    let accountName = "";
-    try {
-      accountName = config.getString(
-        "techdocs.publisher.azureBlobStorage.credentials.accountName"
-      );
-    } catch (error) {
-      throw new Error(
-        "Since techdocs.publisher.type is set to 'azureBlobStorage' in your app config, techdocs.publisher.azureBlobStorage.credentials.accountName is required."
-      );
-    }
-    const accountKey = config.getOptionalString(
-      "techdocs.publisher.azureBlobStorage.credentials.accountKey"
-    );
-    let credential;
-    if (accountKey) {
-      credential = new storageBlob.StorageSharedKeyCredential(accountName, accountKey);
-    } else {
-      credential = new identity.DefaultAzureCredential();
-    }
-    const storageClient = new storageBlob.BlobServiceClient(
-      `https://${accountName}.blob.core.windows.net`,
-      credential
-    );
     const legacyPathCasing = config.getOptionalBoolean(
       "techdocs.legacyUseCaseSensitiveTripletPaths"
     ) || false;
+    const connectionStringKey = "techdocs.publisher.azureBlobStorage.connectionString";
+    const connectionString = config.getOptionalString(connectionStringKey);
+    if (connectionString) {
+      logger.info(
+        `Using '${connectionStringKey}' configuration to create storage client`
+      );
+      storageClient = storageBlob.BlobServiceClient.fromConnectionString(connectionString);
+    } else {
+      let accountName = "";
+      try {
+        accountName = config.getString(
+          "techdocs.publisher.azureBlobStorage.credentials.accountName"
+        );
+      } catch (error) {
+        throw new Error(
+          "Since techdocs.publisher.type is set to 'azureBlobStorage' in your app config, techdocs.publisher.azureBlobStorage.credentials.accountName is required."
+        );
+      }
+      const accountKey = config.getOptionalString(
+        "techdocs.publisher.azureBlobStorage.credentials.accountKey"
+      );
+      let credential;
+      if (accountKey) {
+        credential = new storageBlob.StorageSharedKeyCredential(accountName, accountKey);
+      } else {
+        credential = new identity.DefaultAzureCredential();
+      }
+      storageClient = new storageBlob.BlobServiceClient(
+        `https://${accountName}.blob.core.windows.net`,
+        credential
+      );
+    }
     return new AzureBlobStoragePublish({
       storageClient,
       containerName,