@backstage/plugin-techdocs-node 1.12.9-next.0 → 1.12.9-next.2

package/CHANGELOG.md

@@ -1,5 +1,37 @@
 # @backstage/plugin-techdocs-node
 
+## 1.12.9-next.2
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-plugin-api@0.8.0-next.2
+  - @backstage/backend-common@0.23.4-next.2
+  - @backstage/plugin-search-common@1.2.14-next.1
+  - @backstage/integration@1.14.0-next.0
+  - @backstage/integration-aws-node@0.1.12
+  - @backstage/catalog-model@1.5.0
+  - @backstage/config@1.2.0
+  - @backstage/errors@1.2.4
+  - @backstage/plugin-techdocs-common@0.1.0-next.0
+
+## 1.12.9-next.1
+
+### Patch Changes
+
+- 69bd940: Use annotation constants from new techdocs-common package.
+- 949083d: Update `patchMkdocsYmlPrebuild` to modify `repo_url` and `edit_uri` independently.
+- Updated dependencies
+  - @backstage/plugin-techdocs-common@0.1.0-next.0
+  - @backstage/backend-plugin-api@0.7.1-next.1
+  - @backstage/backend-common@0.23.4-next.1
+  - @backstage/integration@1.14.0-next.0
+  - @backstage/integration-aws-node@0.1.12
+  - @backstage/plugin-search-common@1.2.14-next.0
+  - @backstage/catalog-model@1.5.0
+  - @backstage/config@1.2.0
+  - @backstage/errors@1.2.4
+
 ## 1.12.9-next.0
 
 ### Patch Changes

package/dist/index.cjs.js

@@ -15,6 +15,7 @@ var createLimiter = require('p-limit');
 var recursiveReadDir = require('recursive-readdir');
 var Docker = require('dockerode');
 var util = require('util');
+var pluginTechdocsCommon = require('@backstage/plugin-techdocs-common');
 var integrationAwsNode = require('@backstage/integration-aws-node');
 var clientS3 = require('@aws-sdk/client-s3');
 var credentialProviders = require('@aws-sdk/credential-providers');
@@ -397,15 +398,15 @@ const patchMkdocsFile = async (mkdocsYmlPath, logger, updateAction) => {
 };
 const patchMkdocsYmlPreBuild = async (mkdocsYmlPath, logger, parsedLocationAnnotation, scmIntegrations) => {
   await patchMkdocsFile(mkdocsYmlPath, logger, (mkdocsYml) => {
-    if (!("repo_url" in mkdocsYml) && !("edit_uri" in mkdocsYml)) {
+    if (!("repo_url" in mkdocsYml) || !("edit_uri" in mkdocsYml)) {
       const result = getRepoUrlFromLocationAnnotation(
         parsedLocationAnnotation,
         scmIntegrations,
         mkdocsYml.docs_dir
       );
       if (result.repo_url || result.edit_uri) {
-        mkdocsYml.repo_url = result.repo_url;
-        mkdocsYml.edit_uri = result.edit_uri;
+        mkdocsYml.repo_url = mkdocsYml.repo_url || result.repo_url;
+        mkdocsYml.edit_uri = mkdocsYml.edit_uri || result.edit_uri;
         logger.info(
           `Set ${JSON.stringify(
             result
@@ -743,10 +744,7 @@ const transformDirLocation = (entity, dirAnnotation, scmIntegrations) => {
   }
 };
 const getLocationForEntity = (entity, scmIntegration) => {
-  const annotation = parseReferenceAnnotation(
-    "backstage.io/techdocs-ref",
-    entity
-  );
+  const annotation = parseReferenceAnnotation(pluginTechdocsCommon.TECHDOCS_ANNOTATION, entity);
   switch (annotation.type) {
     case "url":
       return annotation;
@@ -757,10 +755,7 @@ const getLocationForEntity = (entity, scmIntegration) => {
   }
 };
 const getDocFilesFromRepository = async (reader, entity, opts) => {
-  const { target } = parseReferenceAnnotation(
-    "backstage.io/techdocs-ref",
-    entity
-  );
+  const { target } = parseReferenceAnnotation(pluginTechdocsCommon.TECHDOCS_ANNOTATION, entity);
   opts?.logger?.debug(`Reading files from ${target}`);
   const readTreeResponse = await reader.readTree(target, { etag: opts?.etag });
   const preparedDir = await readTreeResponse.dir();
@@ -792,10 +787,7 @@ class DirectoryPreparer {
   }
   /** {@inheritDoc PreparerBase.prepare} */
   async prepare(entity, options) {
-    const annotation = parseReferenceAnnotation(
-      "backstage.io/techdocs-ref",
-      entity
-    );
+    const annotation = parseReferenceAnnotation(pluginTechdocsCommon.TECHDOCS_ANNOTATION, entity);
     const { type, target } = transformDirLocation(
       entity,
       annotation,
@@ -903,10 +895,7 @@ class Preparers {
    * @returns
    */
   get(entity) {
-    const { type } = parseReferenceAnnotation(
-      "backstage.io/techdocs-ref",
-      entity
-    );
+    const { type } = parseReferenceAnnotation(pluginTechdocsCommon.TECHDOCS_ANNOTATION, entity);
     const preparer = this.preparerMap.get(type);
     if (!preparer) {
       throw new Error(`No preparer registered for type: "${type}"`);