@backstage/plugin-techdocs-backend 1.10.6-next.2 → 1.10.6
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 +40 -0
- package/alpha/package.json +1 -1
- package/dist/alpha.cjs.js +0 -8
- package/dist/alpha.cjs.js.map +1 -1
- package/dist/alpha.d.ts +1 -1
- package/package.json +19 -14
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,45 @@
|
|
|
1
1
|
# @backstage/plugin-techdocs-backend
|
|
2
2
|
|
|
3
|
+
## 1.10.6
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- e64bfb2: Allow defining custom build log transport for techdocs builder
|
|
8
|
+
- 8869b8e: Updated local development setup.
|
|
9
|
+
- 78a0b08: Internal refactor to handle `BackendFeature` contract change.
|
|
10
|
+
- 2110d76: Removed `dockerode` dependency.
|
|
11
|
+
- d44a20a: Added additional plugin metadata to `package.json`.
|
|
12
|
+
- Updated dependencies
|
|
13
|
+
- @backstage/backend-common@0.23.0
|
|
14
|
+
- @backstage/backend-plugin-api@0.6.19
|
|
15
|
+
- @backstage/plugin-techdocs-node@1.12.5
|
|
16
|
+
- @backstage/integration@1.12.0
|
|
17
|
+
- @backstage/plugin-search-backend-module-techdocs@0.1.24
|
|
18
|
+
- @backstage/plugin-permission-common@0.7.14
|
|
19
|
+
- @backstage/plugin-catalog-common@1.0.24
|
|
20
|
+
- @backstage/catalog-client@1.6.5
|
|
21
|
+
- @backstage/catalog-model@1.5.0
|
|
22
|
+
- @backstage/config@1.2.0
|
|
23
|
+
- @backstage/errors@1.2.4
|
|
24
|
+
|
|
25
|
+
## 1.10.6-next.3
|
|
26
|
+
|
|
27
|
+
### Patch Changes
|
|
28
|
+
|
|
29
|
+
- d44a20a: Added additional plugin metadata to `package.json`.
|
|
30
|
+
- Updated dependencies
|
|
31
|
+
- @backstage/backend-plugin-api@0.6.19-next.3
|
|
32
|
+
- @backstage/integration@1.12.0-next.1
|
|
33
|
+
- @backstage/plugin-search-backend-module-techdocs@0.1.24-next.3
|
|
34
|
+
- @backstage/plugin-permission-common@0.7.14-next.0
|
|
35
|
+
- @backstage/plugin-catalog-common@1.0.24-next.0
|
|
36
|
+
- @backstage/plugin-techdocs-node@1.12.5-next.3
|
|
37
|
+
- @backstage/backend-common@0.23.0-next.3
|
|
38
|
+
- @backstage/catalog-client@1.6.5
|
|
39
|
+
- @backstage/catalog-model@1.5.0
|
|
40
|
+
- @backstage/config@1.2.0
|
|
41
|
+
- @backstage/errors@1.2.4
|
|
42
|
+
|
|
3
43
|
## 1.10.6-next.2
|
|
4
44
|
|
|
5
45
|
### Patch Changes
|
package/alpha/package.json
CHANGED
package/dist/alpha.cjs.js
CHANGED
|
@@ -5,13 +5,8 @@ Object.defineProperty(exports, '__esModule', { value: true });
|
|
|
5
5
|
var backendCommon = require('@backstage/backend-common');
|
|
6
6
|
var backendPluginApi = require('@backstage/backend-plugin-api');
|
|
7
7
|
var pluginTechdocsNode = require('@backstage/plugin-techdocs-node');
|
|
8
|
-
var Docker = require('dockerode');
|
|
9
8
|
var pluginTechdocsBackend = require('@backstage/plugin-techdocs-backend');
|
|
10
9
|
|
|
11
|
-
function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
|
|
12
|
-
|
|
13
|
-
var Docker__default = /*#__PURE__*/_interopDefaultCompat(Docker);
|
|
14
|
-
|
|
15
10
|
const techdocsPlugin = backendPluginApi.createBackendPlugin({
|
|
16
11
|
pluginId: "techdocs",
|
|
17
12
|
register(env) {
|
|
@@ -80,11 +75,8 @@ const techdocsPlugin = backendPluginApi.createBackendPlugin({
|
|
|
80
75
|
for (const [protocol, preparer] of customPreparers.entries()) {
|
|
81
76
|
preparers.register(protocol, preparer);
|
|
82
77
|
}
|
|
83
|
-
const dockerClient = new Docker__default.default();
|
|
84
|
-
const containerRunner = new backendCommon.DockerContainerRunner({ dockerClient });
|
|
85
78
|
const generators = await pluginTechdocsNode.Generators.fromConfig(config, {
|
|
86
79
|
logger: winstonLogger,
|
|
87
|
-
containerRunner,
|
|
88
80
|
customGenerator: customTechdocsGenerator
|
|
89
81
|
});
|
|
90
82
|
const publisher = await pluginTechdocsNode.Publisher.fromConfig(config, {
|
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 cacheToPluginCacheManager,\n
|
|
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 cacheToPluginCacheManager,\n loggerToWinstonLogger,\n} from '@backstage/backend-common';\nimport {\n coreServices,\n createBackendPlugin,\n} from '@backstage/backend-plugin-api';\n\nimport {\n DocsBuildStrategy,\n Generators,\n PreparerBase,\n Preparers,\n Publisher,\n RemoteProtocol,\n techdocsBuildsExtensionPoint,\n TechdocsGenerator,\n techdocsGeneratorExtensionPoint,\n techdocsPreparerExtensionPoint,\n} from '@backstage/plugin-techdocs-node';\nimport { createRouter } from '@backstage/plugin-techdocs-backend';\nimport * as winston from 'winston';\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 let buildLogTransport: winston.transport | 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 setBuildLogTransport(transport: winston.transport) {\n if (buildLogTransport) {\n throw new Error('BuildLogTransport may only be set once');\n }\n buildLogTransport = transport;\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 const customPreparers = new Map<RemoteProtocol, PreparerBase>();\n env.registerExtensionPoint(techdocsPreparerExtensionPoint, {\n registerPreparer(protocol: RemoteProtocol, preparer: PreparerBase) {\n if (customPreparers.has(protocol)) {\n throw new Error(\n `Preparer for protocol ${protocol} is already registered`,\n );\n }\n customPreparers.set(protocol, preparer);\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 httpAuth: coreServices.httpAuth,\n auth: coreServices.auth,\n },\n async init({\n config,\n logger,\n urlReader,\n http,\n discovery,\n cache,\n httpAuth,\n auth,\n }) {\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 for (const [protocol, preparer] of customPreparers.entries()) {\n preparers.register(protocol, preparer);\n }\n\n // Generators are used for generating documentation sites.\n const generators = await Generators.fromConfig(config, {\n logger: winstonLogger,\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 buildLogTransport,\n preparers,\n generators,\n publisher,\n config,\n discovery,\n httpAuth,\n auth,\n }),\n );\n\n http.addAuthPolicy({\n path: '/static',\n allow: 'user-cookie',\n });\n },\n });\n },\n});\n"],"names":["createBackendPlugin","techdocsBuildsExtensionPoint","techdocsGeneratorExtensionPoint","techdocsPreparerExtensionPoint","coreServices","loggerToWinstonLogger","Preparers","Generators","Publisher","cacheToPluginCacheManager","createRouter"],"mappings":";;;;;;;;;AA4CO,MAAM,iBAAiBA,oCAAoB,CAAA;AAAA,EAChD,QAAU,EAAA,UAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAI,IAAA,iBAAA,CAAA;AACJ,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,MACA,qBAAqB,SAA8B,EAAA;AACjD,QAAA,IAAI,iBAAmB,EAAA;AACrB,UAAM,MAAA,IAAI,MAAM,wCAAwC,CAAA,CAAA;AAAA,SAC1D;AACA,QAAoB,iBAAA,GAAA,SAAA,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,IAAM,MAAA,eAAA,uBAAsB,GAAkC,EAAA,CAAA;AAC9D,IAAA,GAAA,CAAI,uBAAuBC,iDAAgC,EAAA;AAAA,MACzD,gBAAA,CAAiB,UAA0B,QAAwB,EAAA;AACjE,QAAI,IAAA,eAAA,CAAgB,GAAI,CAAA,QAAQ,CAAG,EAAA;AACjC,UAAA,MAAM,IAAI,KAAA;AAAA,YACR,yBAAyB,QAAQ,CAAA,sBAAA,CAAA;AAAA,WACnC,CAAA;AAAA,SACF;AACA,QAAgB,eAAA,CAAA,GAAA,CAAI,UAAU,QAAQ,CAAA,CAAA;AAAA,OACxC;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,QACpB,UAAUA,6BAAa,CAAA,QAAA;AAAA,QACvB,MAAMA,6BAAa,CAAA,IAAA;AAAA,OACrB;AAAA,MACA,MAAM,IAAK,CAAA;AAAA,QACT,MAAA;AAAA,QACA,MAAA;AAAA,QACA,SAAA;AAAA,QACA,IAAA;AAAA,QACA,SAAA;AAAA,QACA,KAAA;AAAA,QACA,QAAA;AAAA,QACA,IAAA;AAAA,OACC,EAAA;AACD,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;AACD,QAAA,KAAA,MAAW,CAAC,QAAU,EAAA,QAAQ,CAAK,IAAA,eAAA,CAAgB,SAAW,EAAA;AAC5D,UAAU,SAAA,CAAA,QAAA,CAAS,UAAU,QAAQ,CAAA,CAAA;AAAA,SACvC;AAGA,QAAA,MAAM,UAAa,GAAA,MAAMC,6BAAW,CAAA,UAAA,CAAW,MAAQ,EAAA;AAAA,UACrD,MAAQ,EAAA,aAAA;AAAA,UACR,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,iBAAA;AAAA,YACA,SAAA;AAAA,YACA,UAAA;AAAA,YACA,SAAA;AAAA,YACA,MAAA;AAAA,YACA,SAAA;AAAA,YACA,QAAA;AAAA,YACA,IAAA;AAAA,WACD,CAAA;AAAA,SACH,CAAA;AAEA,QAAA,IAAA,CAAK,aAAc,CAAA;AAAA,UACjB,IAAM,EAAA,SAAA;AAAA,UACN,KAAO,EAAA,aAAA;AAAA,SACR,CAAA,CAAA;AAAA,OACH;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;"}
|
package/dist/alpha.d.ts
CHANGED
|
@@ -4,6 +4,6 @@ import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
|
|
|
4
4
|
* The TechDocs plugin is responsible for serving and building documentation for any entity.
|
|
5
5
|
* @alpha
|
|
6
6
|
*/
|
|
7
|
-
declare const techdocsPlugin:
|
|
7
|
+
declare const techdocsPlugin: _backstage_backend_plugin_api.BackendFeatureCompat;
|
|
8
8
|
|
|
9
9
|
export { techdocsPlugin as default };
|
package/package.json
CHANGED
|
@@ -1,9 +1,16 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-techdocs-backend",
|
|
3
|
-
"version": "1.10.6
|
|
3
|
+
"version": "1.10.6",
|
|
4
4
|
"description": "The Backstage backend plugin that renders technical documentation for your components",
|
|
5
5
|
"backstage": {
|
|
6
|
-
"role": "backend-plugin"
|
|
6
|
+
"role": "backend-plugin",
|
|
7
|
+
"pluginId": "techdocs",
|
|
8
|
+
"pluginPackages": [
|
|
9
|
+
"@backstage/plugin-techdocs",
|
|
10
|
+
"@backstage/plugin-techdocs-backend",
|
|
11
|
+
"@backstage/plugin-techdocs-node",
|
|
12
|
+
"@backstage/plugin-techdocs-react"
|
|
13
|
+
]
|
|
7
14
|
},
|
|
8
15
|
"publishConfig": {
|
|
9
16
|
"access": "public"
|
|
@@ -49,19 +56,18 @@
|
|
|
49
56
|
"test": "backstage-cli package test"
|
|
50
57
|
},
|
|
51
58
|
"dependencies": {
|
|
52
|
-
"@backstage/backend-common": "^0.23.0
|
|
53
|
-
"@backstage/backend-plugin-api": "^0.6.19
|
|
59
|
+
"@backstage/backend-common": "^0.23.0",
|
|
60
|
+
"@backstage/backend-plugin-api": "^0.6.19",
|
|
54
61
|
"@backstage/catalog-client": "^1.6.5",
|
|
55
62
|
"@backstage/catalog-model": "^1.5.0",
|
|
56
63
|
"@backstage/config": "^1.2.0",
|
|
57
64
|
"@backstage/errors": "^1.2.4",
|
|
58
|
-
"@backstage/integration": "^1.12.0
|
|
59
|
-
"@backstage/plugin-catalog-common": "^1.0.
|
|
60
|
-
"@backstage/plugin-permission-common": "^0.7.
|
|
61
|
-
"@backstage/plugin-search-backend-module-techdocs": "^0.1.24
|
|
62
|
-
"@backstage/plugin-techdocs-node": "^1.12.5
|
|
65
|
+
"@backstage/integration": "^1.12.0",
|
|
66
|
+
"@backstage/plugin-catalog-common": "^1.0.24",
|
|
67
|
+
"@backstage/plugin-permission-common": "^0.7.14",
|
|
68
|
+
"@backstage/plugin-search-backend-module-techdocs": "^0.1.24",
|
|
69
|
+
"@backstage/plugin-techdocs-node": "^1.12.5",
|
|
63
70
|
"@types/express": "^4.17.6",
|
|
64
|
-
"dockerode": "^4.0.0",
|
|
65
71
|
"express": "^4.17.1",
|
|
66
72
|
"express-promise-router": "^4.1.0",
|
|
67
73
|
"fs-extra": "^11.2.0",
|
|
@@ -72,10 +78,9 @@
|
|
|
72
78
|
"winston": "^3.2.1"
|
|
73
79
|
},
|
|
74
80
|
"devDependencies": {
|
|
75
|
-
"@backstage/backend-defaults": "^0.3.0
|
|
76
|
-
"@backstage/backend-test-utils": "^0.4.0
|
|
77
|
-
"@backstage/cli": "^0.26.7
|
|
78
|
-
"@types/dockerode": "^3.3.0",
|
|
81
|
+
"@backstage/backend-defaults": "^0.3.0",
|
|
82
|
+
"@backstage/backend-test-utils": "^0.4.0",
|
|
83
|
+
"@backstage/cli": "^0.26.7",
|
|
79
84
|
"msw": "^1.0.0",
|
|
80
85
|
"supertest": "^6.1.3"
|
|
81
86
|
},
|