@backstage/plugin-techdocs-backend 1.1.2-next.2 → 1.2.0-next.1
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 +108 -0
- package/config.d.ts +7 -0
- package/package.json +14 -14
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,113 @@
|
|
|
1
1
|
# @backstage/plugin-techdocs-backend
|
|
2
2
|
|
|
3
|
+
## 1.2.0-next.1
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- 860765ff45: Added local publishing target directory `config`: `techdocs.publisher.local.publishDirectory`
|
|
8
|
+
|
|
9
|
+
### Patch Changes
|
|
10
|
+
|
|
11
|
+
- 726577958f: Add sample headings on the documented component homepage.
|
|
12
|
+
- Updated dependencies
|
|
13
|
+
- @backstage/plugin-techdocs-node@1.2.0-next.1
|
|
14
|
+
- @backstage/catalog-model@1.1.0-next.1
|
|
15
|
+
- @backstage/backend-common@0.14.1-next.1
|
|
16
|
+
- @backstage/errors@1.1.0-next.0
|
|
17
|
+
- @backstage/catalog-client@1.0.4-next.1
|
|
18
|
+
- @backstage/integration@1.2.2-next.1
|
|
19
|
+
- @backstage/plugin-catalog-common@1.0.4-next.0
|
|
20
|
+
- @backstage/plugin-permission-common@0.6.3-next.0
|
|
21
|
+
- @backstage/plugin-search-common@0.3.6-next.0
|
|
22
|
+
|
|
23
|
+
## 1.1.3-next.0
|
|
24
|
+
|
|
25
|
+
### Patch Changes
|
|
26
|
+
|
|
27
|
+
- Updated dependencies
|
|
28
|
+
- @backstage/backend-common@0.14.1-next.0
|
|
29
|
+
- @backstage/catalog-model@1.1.0-next.0
|
|
30
|
+
- @backstage/integration@1.2.2-next.0
|
|
31
|
+
- @backstage/plugin-techdocs-node@1.1.3-next.0
|
|
32
|
+
- @backstage/catalog-client@1.0.4-next.0
|
|
33
|
+
|
|
34
|
+
## 1.1.2
|
|
35
|
+
|
|
36
|
+
### Patch Changes
|
|
37
|
+
|
|
38
|
+
- 8f7b1835df: Updated dependency `msw` to `^0.41.0`.
|
|
39
|
+
- 61fba6e50b: In order to ensure a good, stable TechDocs user experience when running TechDocs with `techdocs.builder` set to `local`, the number of concurrent builds has been limited to 10. Any additional builds requested concurrently will be queued and handled as prior builds complete. In the unlikely event that you need to handle more concurrent builds, consider scaling out your TechDocs backend deployment or using the `external` option for `techdocs.builder`.
|
|
40
|
+
- 5d66d4ff67: Output logs from a TechDocs build to a logging transport in addition to existing
|
|
41
|
+
frontend event stream, for capturing these logs to other sources.
|
|
42
|
+
|
|
43
|
+
This allows users to capture debugging information around why tech docs fail to build
|
|
44
|
+
without needing to rely on end users capturing information from their web browser.
|
|
45
|
+
|
|
46
|
+
The most common use case is to log to the same place as the rest of the backend
|
|
47
|
+
application logs.
|
|
48
|
+
|
|
49
|
+
Sample usage:
|
|
50
|
+
|
|
51
|
+
```
|
|
52
|
+
import { DockerContainerRunner } from '@backstage/backend-common';
|
|
53
|
+
import {
|
|
54
|
+
createRouter,
|
|
55
|
+
Generators,
|
|
56
|
+
Preparers,
|
|
57
|
+
Publisher,
|
|
58
|
+
} from '@backstage/plugin-techdocs-backend';
|
|
59
|
+
import Docker from 'dockerode';
|
|
60
|
+
import { Router } from 'express';
|
|
61
|
+
import { PluginEnvironment } from '../types';
|
|
62
|
+
|
|
63
|
+
export default async function createPlugin(
|
|
64
|
+
env: PluginEnvironment,
|
|
65
|
+
): Promise<Router> {
|
|
66
|
+
const preparers = await Preparers.fromConfig(env.config, {
|
|
67
|
+
logger: env.logger,
|
|
68
|
+
reader: env.reader,
|
|
69
|
+
});
|
|
70
|
+
|
|
71
|
+
const dockerClient = new Docker();
|
|
72
|
+
const containerRunner = new DockerContainerRunner({ dockerClient });
|
|
73
|
+
|
|
74
|
+
const generators = await Generators.fromConfig(env.config, {
|
|
75
|
+
logger: env.logger,
|
|
76
|
+
containerRunner,
|
|
77
|
+
});
|
|
78
|
+
|
|
79
|
+
const publisher = await Publisher.fromConfig(env.config, {
|
|
80
|
+
logger: env.logger,
|
|
81
|
+
discovery: env.discovery,
|
|
82
|
+
});
|
|
83
|
+
|
|
84
|
+
await publisher.getReadiness();
|
|
85
|
+
|
|
86
|
+
return await createRouter({
|
|
87
|
+
preparers,
|
|
88
|
+
generators,
|
|
89
|
+
publisher,
|
|
90
|
+
logger: env.logger,
|
|
91
|
+
// Passing a buildLogTransport as a parameter in createRouter will enable
|
|
92
|
+
// capturing build logs to a backend log stream
|
|
93
|
+
buildLogTransport: env.logger,
|
|
94
|
+
config: env.config,
|
|
95
|
+
discovery: env.discovery,
|
|
96
|
+
cache: env.cache,
|
|
97
|
+
});
|
|
98
|
+
}
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
- Updated dependencies
|
|
102
|
+
- @backstage/plugin-search-common@0.3.5
|
|
103
|
+
- @backstage/plugin-catalog-common@1.0.3
|
|
104
|
+
- @backstage/backend-common@0.14.0
|
|
105
|
+
- @backstage/integration@1.2.1
|
|
106
|
+
- @backstage/plugin-techdocs-node@1.1.2
|
|
107
|
+
- @backstage/catalog-client@1.0.3
|
|
108
|
+
- @backstage/plugin-permission-common@0.6.2
|
|
109
|
+
- @backstage/catalog-model@1.0.3
|
|
110
|
+
|
|
3
111
|
## 1.1.2-next.2
|
|
4
112
|
|
|
5
113
|
### Patch Changes
|
package/config.d.ts
CHANGED
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-techdocs-backend",
|
|
3
3
|
"description": "The Backstage backend plugin that renders technical documentation for your components",
|
|
4
|
-
"version": "1.
|
|
4
|
+
"version": "1.2.0-next.1",
|
|
5
5
|
"main": "dist/index.cjs.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
7
7
|
"license": "Apache-2.0",
|
|
@@ -34,16 +34,16 @@
|
|
|
34
34
|
"clean": "backstage-cli package clean"
|
|
35
35
|
},
|
|
36
36
|
"dependencies": {
|
|
37
|
-
"@backstage/backend-common": "^0.14.
|
|
38
|
-
"@backstage/catalog-client": "^1.0.
|
|
39
|
-
"@backstage/catalog-model": "^1.0
|
|
37
|
+
"@backstage/backend-common": "^0.14.1-next.1",
|
|
38
|
+
"@backstage/catalog-client": "^1.0.4-next.1",
|
|
39
|
+
"@backstage/catalog-model": "^1.1.0-next.1",
|
|
40
40
|
"@backstage/config": "^1.0.1",
|
|
41
|
-
"@backstage/errors": "^1.0.0",
|
|
42
|
-
"@backstage/integration": "^1.2.
|
|
43
|
-
"@backstage/plugin-catalog-common": "^1.0.
|
|
44
|
-
"@backstage/plugin-permission-common": "^0.6.
|
|
45
|
-
"@backstage/plugin-search-common": "^0.3.
|
|
46
|
-
"@backstage/plugin-techdocs-node": "^1.
|
|
41
|
+
"@backstage/errors": "^1.1.0-next.0",
|
|
42
|
+
"@backstage/integration": "^1.2.2-next.1",
|
|
43
|
+
"@backstage/plugin-catalog-common": "^1.0.4-next.0",
|
|
44
|
+
"@backstage/plugin-permission-common": "^0.6.3-next.0",
|
|
45
|
+
"@backstage/plugin-search-common": "^0.3.6-next.0",
|
|
46
|
+
"@backstage/plugin-techdocs-node": "^1.2.0-next.1",
|
|
47
47
|
"@types/express": "^4.17.6",
|
|
48
48
|
"dockerode": "^3.3.1",
|
|
49
49
|
"express": "^4.17.1",
|
|
@@ -56,9 +56,9 @@
|
|
|
56
56
|
"winston": "^3.2.1"
|
|
57
57
|
},
|
|
58
58
|
"devDependencies": {
|
|
59
|
-
"@backstage/backend-test-utils": "^0.1.
|
|
60
|
-
"@backstage/cli": "^0.
|
|
61
|
-
"@backstage/plugin-search-backend-node": "0.6.
|
|
59
|
+
"@backstage/backend-test-utils": "^0.1.26-next.1",
|
|
60
|
+
"@backstage/cli": "^0.18.0-next.1",
|
|
61
|
+
"@backstage/plugin-search-backend-node": "0.6.3-next.1",
|
|
62
62
|
"@types/dockerode": "^3.3.0",
|
|
63
63
|
"msw": "^0.42.0",
|
|
64
64
|
"supertest": "^6.1.3"
|
|
@@ -68,5 +68,5 @@
|
|
|
68
68
|
"config.d.ts"
|
|
69
69
|
],
|
|
70
70
|
"configSchema": "config.d.ts",
|
|
71
|
-
"gitHead": "
|
|
71
|
+
"gitHead": "e0a993834c31487a97a1ae6878eaf3685f03fc1a"
|
|
72
72
|
}
|