@backstage/plugin-techdocs-node 1.12.7 → 1.12.8-next.1

package/CHANGELOG.md

@@ -1,30 +1,32 @@
 # @backstage/plugin-techdocs-node
 
-## 1.12.7
+## 1.12.8-next.1
 
 ### Patch Changes
 
+- 9ecf5fd: Adds extension point for publishers to the techdocs backend
+- 4c4d077: Bumps default version of techdocs docker image to latest
 - Updated dependencies
-  - @backstage/backend-plugin-api@0.6.21
-  - @backstage/backend-common@0.23.2
+  - @backstage/backend-common@0.23.3-next.1
+  - @backstage/backend-plugin-api@0.6.22-next.1
   - @backstage/catalog-model@1.5.0
   - @backstage/config@1.2.0
   - @backstage/errors@1.2.4
-  - @backstage/integration@1.12.0
+  - @backstage/integration@1.13.0-next.0
   - @backstage/integration-aws-node@0.1.12
   - @backstage/plugin-search-common@1.2.12
 
-## 1.12.6
+## 1.12.7-next.0
 
 ### Patch Changes
 
 - Updated dependencies
-  - @backstage/backend-common@0.23.1
-  - @backstage/backend-plugin-api@0.6.20
+  - @backstage/backend-plugin-api@0.6.21-next.0
+  - @backstage/backend-common@0.23.2-next.0
+  - @backstage/integration@1.13.0-next.0
   - @backstage/catalog-model@1.5.0
   - @backstage/config@1.2.0
   - @backstage/errors@1.2.4
-  - @backstage/integration@1.12.0
   - @backstage/integration-aws-node@0.1.12
   - @backstage/plugin-search-common@1.2.12
 

package/dist/index.cjs.js

@@ -517,7 +517,7 @@ class TechdocsGenerator {
    * The default docker image (and version) used to generate content. Public
    * and static so that techdocs-node consumers can use the same version.
    */
-  static defaultDockerImage = "spotify/techdocs:v1.2.3";
+  static defaultDockerImage = "spotify/techdocs:v1.2.4";
   logger;
   containerRunner;
   options;
@@ -1581,8 +1581,7 @@ class AzureBlobStoragePublish {
       this.logger.warn(e.message);
       return;
     }
-    if (originalPath === newPath)
-      return;
+    if (originalPath === newPath) return;
     try {
       this.logger.verbose(`Migrating ${originalPath}`);
       await this.renameBlob(originalPath, newPath, removeOriginal);
@@ -2417,40 +2416,88 @@ class OpenStackSwiftPublish {
 }
 
 class Publisher {
+  publishers = /* @__PURE__ */ new Map();
+  register(type, publisher) {
+    this.publishers.set(type, publisher);
+  }
+  get(config) {
+    const publisherType = config.getOptionalString(
+      "techdocs.publisher.type"
+    ) ?? "local";
+    if (!publisherType) {
+      throw new Error("TechDocs publisher type not specified for the entity");
+    }
+    const publisher = this.publishers.get(publisherType);
+    if (!publisher) {
+      throw new Error(
+        `TechDocs publisher '${publisherType}' is not registered`
+      );
+    }
+    return publisher;
+  }
   /**
    * Returns a instance of TechDocs publisher
    * @param config - A Backstage configuration
    * @param options - Options for configuring the publisher factory
    */
   static async fromConfig(config, options) {
-    const { logger, discovery } = options;
+    const { logger, discovery, customPublisher } = options;
+    const publishers = new Publisher();
+    if (customPublisher) {
+      publishers.register("techdocs", customPublisher);
+      return customPublisher;
+    }
     const publisherType = config.getOptionalString(
       "techdocs.publisher.type"
     ) ?? "local";
     switch (publisherType) {
       case "googleGcs":
         logger.info("Creating Google Storage Bucket publisher for TechDocs");
-        return GoogleGCSPublish.fromConfig(config, logger);
+        publishers.register(
+          publisherType,
+          GoogleGCSPublish.fromConfig(config, logger)
+        );
+        break;
       case "awsS3":
         logger.info("Creating AWS S3 Bucket publisher for TechDocs");
-        return await AwsS3Publish.fromConfig(config, logger);
+        publishers.register(
+          publisherType,
+          await AwsS3Publish.fromConfig(config, logger)
+        );
+        break;
       case "azureBlobStorage":
         logger.info(
           "Creating Azure Blob Storage Container publisher for TechDocs"
         );
-        return AzureBlobStoragePublish.fromConfig(config, logger);
+        publishers.register(
+          publisherType,
+          AzureBlobStoragePublish.fromConfig(config, logger)
+        );
+        break;
       case "openStackSwift":
         logger.info(
           "Creating OpenStack Swift Container publisher for TechDocs"
         );
-        return OpenStackSwiftPublish.fromConfig(config, logger);
+        publishers.register(
+          publisherType,
+          OpenStackSwiftPublish.fromConfig(config, logger)
+        );
+        break;
       case "local":
         logger.info("Creating Local publisher for TechDocs");
-        return LocalPublish.fromConfig(config, logger, discovery);
+        publishers.register(
+          publisherType,
+          LocalPublish.fromConfig(config, logger, discovery)
+        );
+        break;
       default:
         logger.info("Creating Local publisher for TechDocs");
-        return LocalPublish.fromConfig(config, logger, discovery);
+        publishers.register(
+          publisherType,
+          LocalPublish.fromConfig(config, logger, discovery)
+        );
     }
+    return publishers.get(config);
   }
 }
 
@@ -2463,6 +2510,9 @@ const techdocsGeneratorExtensionPoint = backendPluginApi.createExtensionPoint({
 const techdocsPreparerExtensionPoint = backendPluginApi.createExtensionPoint({
   id: "techdocs.preparer"
 });
+const techdocsPublisherExtensionPoint = backendPluginApi.createExtensionPoint({
+  id: "techdocs.publisher"
+});
 
 exports.DirectoryPreparer = DirectoryPreparer;
 exports.Generators = Generators;
@@ -2478,5 +2528,6 @@ exports.parseReferenceAnnotation = parseReferenceAnnotation;
 exports.techdocsBuildsExtensionPoint = techdocsBuildsExtensionPoint;
 exports.techdocsGeneratorExtensionPoint = techdocsGeneratorExtensionPoint;
 exports.techdocsPreparerExtensionPoint = techdocsPreparerExtensionPoint;
+exports.techdocsPublisherExtensionPoint = techdocsPublisherExtensionPoint;
 exports.transformDirLocation = transformDirLocation;
 //# sourceMappingURL=index.cjs.js.map