@backstage/plugin-techdocs-backend 0.0.0-nightly-20240304022137 → 0.0.0-nightly-20240306021012

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.
Files changed (5) hide show
  1. package/CHANGELOG.md +33 -12
  2. package/alpha/package.json +1 -1
  3. package/dist/alpha.cjs.js +11 -1
  4. package/dist/alpha.cjs.js.map +1 -1
  5. package/package.json +14 -14
package/CHANGELOG.md CHANGED
@@ -1,21 +1,42 @@
1
1
  # @backstage/plugin-techdocs-backend
2
2
 
3
- ## 0.0.0-nightly-20240304022137
3
+ ## 0.0.0-nightly-20240306021012
4
+
5
+ ### Minor Changes
6
+
7
+ - 718b734: Create extension point `TechdocsGeneratorExtensionPoint` to allow adding a custom generator
4
8
 
5
9
  ### Patch Changes
6
10
 
7
11
  - Updated dependencies
8
- - @backstage/backend-common@0.0.0-nightly-20240304022137
9
- - @backstage/config@0.0.0-nightly-20240304022137
10
- - @backstage/errors@0.0.0-nightly-20240304022137
11
- - @backstage/backend-plugin-api@0.0.0-nightly-20240304022137
12
- - @backstage/plugin-techdocs-node@0.0.0-nightly-20240304022137
13
- - @backstage/plugin-permission-common@0.0.0-nightly-20240304022137
14
- - @backstage/plugin-search-backend-module-techdocs@0.0.0-nightly-20240304022137
15
- - @backstage/integration@0.0.0-nightly-20240304022137
16
- - @backstage/catalog-client@0.0.0-nightly-20240304022137
17
- - @backstage/catalog-model@0.0.0-nightly-20240304022137
18
- - @backstage/plugin-catalog-common@0.0.0-nightly-20240304022137
12
+ - @backstage/backend-common@0.0.0-nightly-20240306021012
13
+ - @backstage/config@0.0.0-nightly-20240306021012
14
+ - @backstage/errors@0.0.0-nightly-20240306021012
15
+ - @backstage/backend-plugin-api@0.0.0-nightly-20240306021012
16
+ - @backstage/plugin-techdocs-node@0.0.0-nightly-20240306021012
17
+ - @backstage/plugin-permission-common@0.0.0-nightly-20240306021012
18
+ - @backstage/plugin-search-backend-module-techdocs@0.0.0-nightly-20240306021012
19
+ - @backstage/integration@0.0.0-nightly-20240306021012
20
+ - @backstage/catalog-client@0.0.0-nightly-20240306021012
21
+ - @backstage/catalog-model@0.0.0-nightly-20240306021012
22
+ - @backstage/plugin-catalog-common@0.0.0-nightly-20240306021012
23
+
24
+ ## 1.9.7-next.1
25
+
26
+ ### Patch Changes
27
+
28
+ - Updated dependencies
29
+ - @backstage/config@1.2.0-next.1
30
+ - @backstage/backend-common@0.21.4-next.1
31
+ - @backstage/backend-plugin-api@0.6.14-next.1
32
+ - @backstage/integration@1.9.1-next.1
33
+ - @backstage/plugin-permission-common@0.7.13-next.1
34
+ - @backstage/plugin-search-backend-module-techdocs@0.1.18-next.1
35
+ - @backstage/plugin-techdocs-node@1.11.6-next.1
36
+ - @backstage/catalog-client@1.6.1-next.0
37
+ - @backstage/catalog-model@1.4.5-next.0
38
+ - @backstage/errors@1.2.4-next.0
39
+ - @backstage/plugin-catalog-common@1.0.22-next.1
19
40
 
20
41
  ## 1.9.6-next.0
21
42
 
package/alpha/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-techdocs-backend",
3
- "version": "0.0.0-nightly-20240304022137",
3
+ "version": "0.0.0-nightly-20240306021012",
4
4
  "main": "../dist/alpha.cjs.js",
5
5
  "types": "../dist/alpha.d.ts"
6
6
  }
package/dist/alpha.cjs.js CHANGED
@@ -24,6 +24,15 @@ const techdocsPlugin = backendPluginApi.createBackendPlugin({
24
24
  docsBuildStrategy = buildStrategy;
25
25
  }
26
26
  });
27
+ let customTechdocsGenerator;
28
+ env.registerExtensionPoint(pluginTechdocsNode.techdocsGeneratorExtensionPoint, {
29
+ setTechdocsGenerator(generator) {
30
+ if (customTechdocsGenerator) {
31
+ throw new Error("TechdocsGenerator may only be set once");
32
+ }
33
+ customTechdocsGenerator = generator;
34
+ }
35
+ });
27
36
  env.registerInit({
28
37
  deps: {
29
38
  config: backendPluginApi.coreServices.rootConfig,
@@ -43,7 +52,8 @@ const techdocsPlugin = backendPluginApi.createBackendPlugin({
43
52
  const containerRunner = new backendCommon.DockerContainerRunner({ dockerClient });
44
53
  const generators = await pluginTechdocsNode.Generators.fromConfig(config, {
45
54
  logger: winstonLogger,
46
- containerRunner
55
+ containerRunner,
56
+ customGenerator: customTechdocsGenerator
47
57
  });
48
58
  const publisher = await pluginTechdocsNode.Publisher.fromConfig(config, {
49
59
  logger: winstonLogger,
package/dist/alpha.cjs.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"alpha.cjs.js","sources":["../src/plugin.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n DockerContainerRunner,\n loggerToWinstonLogger,\n cacheToPluginCacheManager,\n} from '@backstage/backend-common';\nimport {\n coreServices,\n createBackendPlugin,\n} from '@backstage/backend-plugin-api';\n\nimport {\n DocsBuildStrategy,\n Preparers,\n Generators,\n Publisher,\n techdocsBuildsExtensionPoint,\n} from '@backstage/plugin-techdocs-node';\nimport Docker from 'dockerode';\nimport { createRouter } from '@backstage/plugin-techdocs-backend';\n\n/**\n * The TechDocs plugin is responsible for serving and building documentation for any entity.\n * @alpha\n */\nexport const techdocsPlugin = createBackendPlugin({\n pluginId: 'techdocs',\n register(env) {\n let docsBuildStrategy: DocsBuildStrategy | undefined;\n env.registerExtensionPoint(techdocsBuildsExtensionPoint, {\n setBuildStrategy(buildStrategy: DocsBuildStrategy) {\n if (docsBuildStrategy) {\n throw new Error('DocsBuildStrategy may only be set once');\n }\n docsBuildStrategy = buildStrategy;\n },\n });\n\n env.registerInit({\n deps: {\n config: coreServices.rootConfig,\n logger: coreServices.logger,\n urlReader: coreServices.urlReader,\n http: coreServices.httpRouter,\n discovery: coreServices.discovery,\n cache: coreServices.cache,\n },\n async init({ config, logger, urlReader, http, discovery, cache }) {\n const winstonLogger = loggerToWinstonLogger(logger);\n // Preparers are responsible for fetching source files for documentation.\n const preparers = await Preparers.fromConfig(config, {\n reader: urlReader,\n logger: winstonLogger,\n });\n\n // Docker client (conditionally) used by the generators, based on techdocs.generators config.\n const dockerClient = new Docker();\n const containerRunner = new DockerContainerRunner({ dockerClient });\n\n // Generators are used for generating documentation sites.\n const generators = await Generators.fromConfig(config, {\n logger: winstonLogger,\n containerRunner,\n });\n\n // Publisher is used for\n // 1. Publishing generated files to storage\n // 2. Fetching files from storage and passing them to TechDocs frontend.\n const publisher = await Publisher.fromConfig(config, {\n logger: winstonLogger,\n discovery: discovery,\n });\n\n // checks if the publisher is working and logs the result\n await publisher.getReadiness();\n\n const cacheManager = cacheToPluginCacheManager(cache);\n http.use(\n await createRouter({\n logger: winstonLogger,\n cache: cacheManager,\n docsBuildStrategy,\n preparers,\n generators,\n publisher,\n config,\n discovery,\n }),\n );\n },\n });\n },\n});\n"],"names":["createBackendPlugin","techdocsBuildsExtensionPoint","coreServices","loggerToWinstonLogger","Preparers","Docker","DockerContainerRunner","Generators","Publisher","cacheToPluginCacheManager","createRouter"],"mappings":";;;;;;;;;;;;;;AAwCO,MAAM,iBAAiBA,oCAAoB,CAAA;AAAA,EAChD,QAAU,EAAA,UAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAI,IAAA,iBAAA,CAAA;AACJ,IAAA,GAAA,CAAI,uBAAuBC,+CAA8B,EAAA;AAAA,MACvD,iBAAiB,aAAkC,EAAA;AACjD,QAAA,IAAI,iBAAmB,EAAA;AACrB,UAAM,MAAA,IAAI,MAAM,wCAAwC,CAAA,CAAA;AAAA,SAC1D;AACA,QAAoB,iBAAA,GAAA,aAAA,CAAA;AAAA,OACtB;AAAA,KACD,CAAA,CAAA;AAED,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,QAAQC,6BAAa,CAAA,UAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,MAAMA,6BAAa,CAAA,UAAA;AAAA,QACnB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,OAAOA,6BAAa,CAAA,KAAA;AAAA,OACtB;AAAA,MACA,MAAM,KAAK,EAAE,MAAA,EAAQ,QAAQ,SAAW,EAAA,IAAA,EAAM,SAAW,EAAA,KAAA,EAAS,EAAA;AAChE,QAAM,MAAA,aAAA,GAAgBC,oCAAsB,MAAM,CAAA,CAAA;AAElD,QAAA,MAAM,SAAY,GAAA,MAAMC,4BAAU,CAAA,UAAA,CAAW,MAAQ,EAAA;AAAA,UACnD,MAAQ,EAAA,SAAA;AAAA,UACR,MAAQ,EAAA,aAAA;AAAA,SACT,CAAA,CAAA;AAGD,QAAM,MAAA,YAAA,GAAe,IAAIC,0BAAO,EAAA,CAAA;AAChC,QAAA,MAAM,eAAkB,GAAA,IAAIC,mCAAsB,CAAA,EAAE,cAAc,CAAA,CAAA;AAGlE,QAAA,MAAM,UAAa,GAAA,MAAMC,6BAAW,CAAA,UAAA,CAAW,MAAQ,EAAA;AAAA,UACrD,MAAQ,EAAA,aAAA;AAAA,UACR,eAAA;AAAA,SACD,CAAA,CAAA;AAKD,QAAA,MAAM,SAAY,GAAA,MAAMC,4BAAU,CAAA,UAAA,CAAW,MAAQ,EAAA;AAAA,UACnD,MAAQ,EAAA,aAAA;AAAA,UACR,SAAA;AAAA,SACD,CAAA,CAAA;AAGD,QAAA,MAAM,UAAU,YAAa,EAAA,CAAA;AAE7B,QAAM,MAAA,YAAA,GAAeC,wCAA0B,KAAK,CAAA,CAAA;AACpD,QAAK,IAAA,CAAA,GAAA;AAAA,UACH,MAAMC,kCAAa,CAAA;AAAA,YACjB,MAAQ,EAAA,aAAA;AAAA,YACR,KAAO,EAAA,YAAA;AAAA,YACP,iBAAA;AAAA,YACA,SAAA;AAAA,YACA,UAAA;AAAA,YACA,SAAA;AAAA,YACA,MAAA;AAAA,YACA,SAAA;AAAA,WACD,CAAA;AAAA,SACH,CAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;"}
1
+ {"version":3,"file":"alpha.cjs.js","sources":["../src/plugin.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n DockerContainerRunner,\n loggerToWinstonLogger,\n cacheToPluginCacheManager,\n} from '@backstage/backend-common';\nimport {\n coreServices,\n createBackendPlugin,\n} from '@backstage/backend-plugin-api';\n\nimport {\n DocsBuildStrategy,\n Preparers,\n Generators,\n Publisher,\n techdocsBuildsExtensionPoint,\n techdocsGeneratorExtensionPoint,\n TechdocsGenerator,\n} from '@backstage/plugin-techdocs-node';\nimport Docker from 'dockerode';\nimport { createRouter } from '@backstage/plugin-techdocs-backend';\n\n/**\n * The TechDocs plugin is responsible for serving and building documentation for any entity.\n * @alpha\n */\nexport const techdocsPlugin = createBackendPlugin({\n pluginId: 'techdocs',\n register(env) {\n let docsBuildStrategy: DocsBuildStrategy | undefined;\n env.registerExtensionPoint(techdocsBuildsExtensionPoint, {\n setBuildStrategy(buildStrategy: DocsBuildStrategy) {\n if (docsBuildStrategy) {\n throw new Error('DocsBuildStrategy may only be set once');\n }\n docsBuildStrategy = buildStrategy;\n },\n });\n\n let customTechdocsGenerator: TechdocsGenerator | undefined;\n env.registerExtensionPoint(techdocsGeneratorExtensionPoint, {\n setTechdocsGenerator(generator: TechdocsGenerator) {\n if (customTechdocsGenerator) {\n throw new Error('TechdocsGenerator may only be set once');\n }\n\n customTechdocsGenerator = generator;\n },\n });\n\n env.registerInit({\n deps: {\n config: coreServices.rootConfig,\n logger: coreServices.logger,\n urlReader: coreServices.urlReader,\n http: coreServices.httpRouter,\n discovery: coreServices.discovery,\n cache: coreServices.cache,\n },\n async init({ config, logger, urlReader, http, discovery, cache }) {\n const winstonLogger = loggerToWinstonLogger(logger);\n // Preparers are responsible for fetching source files for documentation.\n const preparers = await Preparers.fromConfig(config, {\n reader: urlReader,\n logger: winstonLogger,\n });\n\n // Docker client (conditionally) used by the generators, based on techdocs.generators config.\n const dockerClient = new Docker();\n const containerRunner = new DockerContainerRunner({ dockerClient });\n\n // Generators are used for generating documentation sites.\n const generators = await Generators.fromConfig(config, {\n logger: winstonLogger,\n containerRunner,\n customGenerator: customTechdocsGenerator,\n });\n\n // Publisher is used for\n // 1. Publishing generated files to storage\n // 2. Fetching files from storage and passing them to TechDocs frontend.\n const publisher = await Publisher.fromConfig(config, {\n logger: winstonLogger,\n discovery: discovery,\n });\n\n // checks if the publisher is working and logs the result\n await publisher.getReadiness();\n\n const cacheManager = cacheToPluginCacheManager(cache);\n http.use(\n await createRouter({\n logger: winstonLogger,\n cache: cacheManager,\n docsBuildStrategy,\n preparers,\n generators,\n publisher,\n config,\n discovery,\n }),\n );\n },\n });\n },\n});\n"],"names":["createBackendPlugin","techdocsBuildsExtensionPoint","techdocsGeneratorExtensionPoint","coreServices","loggerToWinstonLogger","Preparers","Docker","DockerContainerRunner","Generators","Publisher","cacheToPluginCacheManager","createRouter"],"mappings":";;;;;;;;;;;;;;AA0CO,MAAM,iBAAiBA,oCAAoB,CAAA;AAAA,EAChD,QAAU,EAAA,UAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAI,IAAA,iBAAA,CAAA;AACJ,IAAA,GAAA,CAAI,uBAAuBC,+CAA8B,EAAA;AAAA,MACvD,iBAAiB,aAAkC,EAAA;AACjD,QAAA,IAAI,iBAAmB,EAAA;AACrB,UAAM,MAAA,IAAI,MAAM,wCAAwC,CAAA,CAAA;AAAA,SAC1D;AACA,QAAoB,iBAAA,GAAA,aAAA,CAAA;AAAA,OACtB;AAAA,KACD,CAAA,CAAA;AAED,IAAI,IAAA,uBAAA,CAAA;AACJ,IAAA,GAAA,CAAI,uBAAuBC,kDAAiC,EAAA;AAAA,MAC1D,qBAAqB,SAA8B,EAAA;AACjD,QAAA,IAAI,uBAAyB,EAAA;AAC3B,UAAM,MAAA,IAAI,MAAM,wCAAwC,CAAA,CAAA;AAAA,SAC1D;AAEA,QAA0B,uBAAA,GAAA,SAAA,CAAA;AAAA,OAC5B;AAAA,KACD,CAAA,CAAA;AAED,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,QAAQC,6BAAa,CAAA,UAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,MAAMA,6BAAa,CAAA,UAAA;AAAA,QACnB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,OAAOA,6BAAa,CAAA,KAAA;AAAA,OACtB;AAAA,MACA,MAAM,KAAK,EAAE,MAAA,EAAQ,QAAQ,SAAW,EAAA,IAAA,EAAM,SAAW,EAAA,KAAA,EAAS,EAAA;AAChE,QAAM,MAAA,aAAA,GAAgBC,oCAAsB,MAAM,CAAA,CAAA;AAElD,QAAA,MAAM,SAAY,GAAA,MAAMC,4BAAU,CAAA,UAAA,CAAW,MAAQ,EAAA;AAAA,UACnD,MAAQ,EAAA,SAAA;AAAA,UACR,MAAQ,EAAA,aAAA;AAAA,SACT,CAAA,CAAA;AAGD,QAAM,MAAA,YAAA,GAAe,IAAIC,0BAAO,EAAA,CAAA;AAChC,QAAA,MAAM,eAAkB,GAAA,IAAIC,mCAAsB,CAAA,EAAE,cAAc,CAAA,CAAA;AAGlE,QAAA,MAAM,UAAa,GAAA,MAAMC,6BAAW,CAAA,UAAA,CAAW,MAAQ,EAAA;AAAA,UACrD,MAAQ,EAAA,aAAA;AAAA,UACR,eAAA;AAAA,UACA,eAAiB,EAAA,uBAAA;AAAA,SAClB,CAAA,CAAA;AAKD,QAAA,MAAM,SAAY,GAAA,MAAMC,4BAAU,CAAA,UAAA,CAAW,MAAQ,EAAA;AAAA,UACnD,MAAQ,EAAA,aAAA;AAAA,UACR,SAAA;AAAA,SACD,CAAA,CAAA;AAGD,QAAA,MAAM,UAAU,YAAa,EAAA,CAAA;AAE7B,QAAM,MAAA,YAAA,GAAeC,wCAA0B,KAAK,CAAA,CAAA;AACpD,QAAK,IAAA,CAAA,GAAA;AAAA,UACH,MAAMC,kCAAa,CAAA;AAAA,YACjB,MAAQ,EAAA,aAAA;AAAA,YACR,KAAO,EAAA,YAAA;AAAA,YACP,iBAAA;AAAA,YACA,SAAA;AAAA,YACA,UAAA;AAAA,YACA,SAAA;AAAA,YACA,MAAA;AAAA,YACA,SAAA;AAAA,WACD,CAAA;AAAA,SACH,CAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-techdocs-backend",
3
- "version": "0.0.0-nightly-20240304022137",
3
+ "version": "0.0.0-nightly-20240306021012",
4
4
  "description": "The Backstage backend plugin that renders technical documentation for your components",
5
5
  "backstage": {
6
6
  "role": "backend-plugin"
@@ -49,17 +49,17 @@
49
49
  "test": "backstage-cli package test"
50
50
  },
51
51
  "dependencies": {
52
- "@backstage/backend-common": "^0.0.0-nightly-20240304022137",
53
- "@backstage/backend-plugin-api": "^0.0.0-nightly-20240304022137",
54
- "@backstage/catalog-client": "^0.0.0-nightly-20240304022137",
55
- "@backstage/catalog-model": "^0.0.0-nightly-20240304022137",
56
- "@backstage/config": "^0.0.0-nightly-20240304022137",
57
- "@backstage/errors": "^0.0.0-nightly-20240304022137",
58
- "@backstage/integration": "^0.0.0-nightly-20240304022137",
59
- "@backstage/plugin-catalog-common": "^0.0.0-nightly-20240304022137",
60
- "@backstage/plugin-permission-common": "^0.0.0-nightly-20240304022137",
61
- "@backstage/plugin-search-backend-module-techdocs": "^0.0.0-nightly-20240304022137",
62
- "@backstage/plugin-techdocs-node": "^0.0.0-nightly-20240304022137",
52
+ "@backstage/backend-common": "^0.0.0-nightly-20240306021012",
53
+ "@backstage/backend-plugin-api": "^0.0.0-nightly-20240306021012",
54
+ "@backstage/catalog-client": "^0.0.0-nightly-20240306021012",
55
+ "@backstage/catalog-model": "^0.0.0-nightly-20240306021012",
56
+ "@backstage/config": "^0.0.0-nightly-20240306021012",
57
+ "@backstage/errors": "^0.0.0-nightly-20240306021012",
58
+ "@backstage/integration": "^0.0.0-nightly-20240306021012",
59
+ "@backstage/plugin-catalog-common": "^0.0.0-nightly-20240306021012",
60
+ "@backstage/plugin-permission-common": "^0.0.0-nightly-20240306021012",
61
+ "@backstage/plugin-search-backend-module-techdocs": "^0.0.0-nightly-20240306021012",
62
+ "@backstage/plugin-techdocs-node": "^0.0.0-nightly-20240306021012",
63
63
  "@types/express": "^4.17.6",
64
64
  "dockerode": "^4.0.0",
65
65
  "express": "^4.17.1",
@@ -72,8 +72,8 @@
72
72
  "winston": "^3.2.1"
73
73
  },
74
74
  "devDependencies": {
75
- "@backstage/backend-test-utils": "^0.0.0-nightly-20240304022137",
76
- "@backstage/cli": "^0.0.0-nightly-20240304022137",
75
+ "@backstage/backend-test-utils": "^0.0.0-nightly-20240306021012",
76
+ "@backstage/cli": "^0.0.0-nightly-20240306021012",
77
77
  "@types/dockerode": "^3.3.0",
78
78
  "msw": "^1.0.0",
79
79
  "supertest": "^6.1.3"