@backstage/plugin-techdocs-node 0.0.0-nightly-20240730021827 → 0.0.0-nightly-20240731020649

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,19 +1,38 @@
1
1
  # @backstage/plugin-techdocs-node
2
2
 
3
- ## 0.0.0-nightly-20240730021827
3
+ ## 0.0.0-nightly-20240731020649
4
4
 
5
5
  ### Patch Changes
6
6
 
7
+ - 69bd940: Use annotation constants from new techdocs-common package.
7
8
  - 949083d: Update `patchMkdocsYmlPrebuild` to modify `repo_url` and `edit_uri` independently.
8
9
  - Updated dependencies
9
- - @backstage/backend-common@0.0.0-nightly-20240730021827
10
- - @backstage/integration@0.0.0-nightly-20240730021827
11
- - @backstage/backend-plugin-api@0.0.0-nightly-20240730021827
10
+ - @backstage/backend-common@0.0.0-nightly-20240731020649
11
+ - @backstage/integration@0.0.0-nightly-20240731020649
12
+ - @backstage/plugin-techdocs-common@0.0.0-nightly-20240731020649
13
+ - @backstage/backend-plugin-api@0.0.0-nightly-20240731020649
12
14
  - @backstage/catalog-model@1.5.0
13
15
  - @backstage/config@1.2.0
14
16
  - @backstage/errors@1.2.4
15
17
  - @backstage/integration-aws-node@0.1.12
16
- - @backstage/plugin-search-common@0.0.0-nightly-20240730021827
18
+ - @backstage/plugin-search-common@0.0.0-nightly-20240731020649
19
+
20
+ ## 1.12.9-next.1
21
+
22
+ ### Patch Changes
23
+
24
+ - 69bd940: Use annotation constants from new techdocs-common package.
25
+ - 949083d: Update `patchMkdocsYmlPrebuild` to modify `repo_url` and `edit_uri` independently.
26
+ - Updated dependencies
27
+ - @backstage/plugin-techdocs-common@0.1.0-next.0
28
+ - @backstage/backend-plugin-api@0.7.1-next.1
29
+ - @backstage/backend-common@0.23.4-next.1
30
+ - @backstage/integration@1.14.0-next.0
31
+ - @backstage/integration-aws-node@0.1.12
32
+ - @backstage/plugin-search-common@1.2.14-next.0
33
+ - @backstage/catalog-model@1.5.0
34
+ - @backstage/config@1.2.0
35
+ - @backstage/errors@1.2.4
17
36
 
18
37
  ## 1.12.9-next.0
19
38
 
package/dist/index.cjs.js CHANGED
@@ -15,6 +15,7 @@ var createLimiter = require('p-limit');
15
15
  var recursiveReadDir = require('recursive-readdir');
16
16
  var Docker = require('dockerode');
17
17
  var util = require('util');
18
+ var pluginTechdocsCommon = require('@backstage/plugin-techdocs-common');
18
19
  var integrationAwsNode = require('@backstage/integration-aws-node');
19
20
  var clientS3 = require('@aws-sdk/client-s3');
20
21
  var credentialProviders = require('@aws-sdk/credential-providers');
@@ -743,10 +744,7 @@ const transformDirLocation = (entity, dirAnnotation, scmIntegrations) => {
743
744
  }
744
745
  };
745
746
  const getLocationForEntity = (entity, scmIntegration) => {
746
- const annotation = parseReferenceAnnotation(
747
- "backstage.io/techdocs-ref",
748
- entity
749
- );
747
+ const annotation = parseReferenceAnnotation(pluginTechdocsCommon.TECHDOCS_ANNOTATION, entity);
750
748
  switch (annotation.type) {
751
749
  case "url":
752
750
  return annotation;
@@ -757,10 +755,7 @@ const getLocationForEntity = (entity, scmIntegration) => {
757
755
  }
758
756
  };
759
757
  const getDocFilesFromRepository = async (reader, entity, opts) => {
760
- const { target } = parseReferenceAnnotation(
761
- "backstage.io/techdocs-ref",
762
- entity
763
- );
758
+ const { target } = parseReferenceAnnotation(pluginTechdocsCommon.TECHDOCS_ANNOTATION, entity);
764
759
  opts?.logger?.debug(`Reading files from ${target}`);
765
760
  const readTreeResponse = await reader.readTree(target, { etag: opts?.etag });
766
761
  const preparedDir = await readTreeResponse.dir();
@@ -792,10 +787,7 @@ class DirectoryPreparer {
792
787
  }
793
788
  /** {@inheritDoc PreparerBase.prepare} */
794
789
  async prepare(entity, options) {
795
- const annotation = parseReferenceAnnotation(
796
- "backstage.io/techdocs-ref",
797
- entity
798
- );
790
+ const annotation = parseReferenceAnnotation(pluginTechdocsCommon.TECHDOCS_ANNOTATION, entity);
799
791
  const { type, target } = transformDirLocation(
800
792
  entity,
801
793
  annotation,
@@ -903,10 +895,7 @@ class Preparers {
903
895
  * @returns
904
896
  */
905
897
  get(entity) {
906
- const { type } = parseReferenceAnnotation(
907
- "backstage.io/techdocs-ref",
908
- entity
909
- );
898
+ const { type } = parseReferenceAnnotation(pluginTechdocsCommon.TECHDOCS_ANNOTATION, entity);
910
899
  const preparer = this.preparerMap.get(type);
911
900
  if (!preparer) {
912
901
  throw new Error(`No preparer registered for type: "${type}"`);