@backstage/plugin-techdocs-node 1.8.2 → 1.9.0

package/CHANGELOG.md

@@ -1,18 +1,78 @@
 # @backstage/plugin-techdocs-node
 
-## 1.8.2
+## 1.9.0
+
+### Minor Changes
+
+- 344cfbcfbc: Allow prepared directory clean up for custom preparers
+
+  When using custom preparer for TechDocs, the `preparedDir` might
+  end up taking disk space. This requires all custom preparers to
+  implement a new method `shouldCleanPreparedDirectory` which indicates
+  whether the prepared directory should be cleaned after generation.
+
+- d06b30b050: Add possibility to use a mkdocs config file with a different name than `mkdocs.<yaml|yml> with the serve command using the `--mkdocs-config-file-name` argument
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-common@0.19.8
+  - @backstage/integration@1.7.1
+  - @backstage/catalog-model@1.4.3
+  - @backstage/errors@1.2.3
+  - @backstage/config@1.1.1
+  - @backstage/integration-aws-node@0.1.7
+  - @backstage/plugin-search-common@1.2.7
+
+## 1.9.0-next.2
+
+### Minor Changes
+
+- 344cfbcfbc: Allow prepared directory clean up for custom preparers
+
+  When using custom preparer for TechDocs, the `preparedDir` might
+  end up taking disk space. This requires all custom preparers to
+  implement a new method `shouldCleanPreparedDirectory` which indicates
+  whether the prepared directory should be cleaned after generation.
+
+- d06b30b050: Add possibility to use a mkdocs config file with a different name than `mkdocs.<yaml|yml> with the serve command using the `--mkdocs-config-file-name` argument
 
 ### Patch Changes
 
 - Updated dependencies
-  - @backstage/backend-common@0.19.7
+  - @backstage/backend-common@0.19.8-next.2
+  - @backstage/catalog-model@1.4.3-next.0
+  - @backstage/integration@1.7.1-next.1
+  - @backstage/errors@1.2.3-next.0
+  - @backstage/config@1.1.1-next.0
+  - @backstage/integration-aws-node@0.1.7-next.0
+  - @backstage/plugin-search-common@1.2.7-next.0
 
-## 1.8.1
+## 1.8.2-next.1
 
 ### Patch Changes
 
 - Updated dependencies
-  - @backstage/backend-common@0.19.6
+  - @backstage/backend-common@0.19.7-next.1
+  - @backstage/config@1.1.0
+  - @backstage/integration-aws-node@0.1.6
+  - @backstage/catalog-model@1.4.2
+  - @backstage/errors@1.2.2
+  - @backstage/integration@1.7.1-next.0
+  - @backstage/plugin-search-common@1.2.6
+
+## 1.8.2-next.0
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/integration@1.7.1-next.0
+  - @backstage/backend-common@0.19.7-next.0
+  - @backstage/config@1.1.0
+  - @backstage/integration-aws-node@0.1.6
+  - @backstage/catalog-model@1.4.2
+  - @backstage/errors@1.2.2
+  - @backstage/plugin-search-common@1.2.6
 
 ## 1.8.0
 

package/dist/index.cjs.js

@@ -226,10 +226,22 @@ const generateMkdocsYml = async (inputDir, siteOptions) => {
     throw new errors.ForwardedError("Could not generate mkdocs.yml file", error);
   }
 };
-const getMkdocsYml = async (inputDir, siteOptions) => {
+const getMkdocsYml = async (inputDir, options) => {
   let mkdocsYmlPath;
   let mkdocsYmlFileString;
   try {
+    if (options == null ? void 0 : options.mkdocsConfigFileName) {
+      mkdocsYmlPath = path__default["default"].join(inputDir, options.mkdocsConfigFileName);
+      if (!await fs__default["default"].pathExists(mkdocsYmlPath)) {
+        throw new Error(`The specified file ${mkdocsYmlPath} does not exist`);
+      }
+      mkdocsYmlFileString = await fs__default["default"].readFile(mkdocsYmlPath, "utf8");
+      return {
+        path: mkdocsYmlPath,
+        content: mkdocsYmlFileString,
+        configIsTemporary: false
+      };
+    }
     mkdocsYmlPath = path__default["default"].join(inputDir, "mkdocs.yaml");
     if (await fs__default["default"].pathExists(mkdocsYmlPath)) {
       mkdocsYmlFileString = await fs__default["default"].readFile(mkdocsYmlPath, "utf8");
@@ -248,7 +260,7 @@ const getMkdocsYml = async (inputDir, siteOptions) => {
         configIsTemporary: false
       };
     }
-    await generateMkdocsYml(inputDir, siteOptions);
+    await generateMkdocsYml(inputDir, options);
     mkdocsYmlFileString = await fs__default["default"].readFile(mkdocsYmlPath, "utf8");
   } catch (error) {
     throw new errors.ForwardedError(
@@ -726,6 +738,10 @@ class DirectoryPreparer {
   static fromConfig(config, options) {
     return new DirectoryPreparer(config, options.logger, options.reader);
   }
+  /** {@inheritDoc PreparerBase.shouldCleanPreparedDirectory} */
+  shouldCleanPreparedDirectory() {
+    return false;
+  }
   /** {@inheritDoc PreparerBase.prepare} */
   async prepare(entity, options) {
     var _a, _b;
@@ -785,6 +801,10 @@ class UrlPreparer {
   static fromConfig(options) {
     return new UrlPreparer(options.reader, options.logger);
   }
+  /** {@inheritDoc PreparerBase.shouldCleanPreparedDirectory} */
+  shouldCleanPreparedDirectory() {
+    return true;
+  }
   /** {@inheritDoc PreparerBase.prepare} */
   async prepare(entity, options) {
     try {