Merge branch 'refs/heads/master' into tech-docs-search-by-title

This commit is contained in:
Stephen A. Wilson
2024-06-22 15:48:34 -04:00
944 changed files with 16293 additions and 4862 deletions
+22
View File
@@ -1,5 +1,27 @@
# @backstage/plugin-techdocs-backend
## 1.10.6
### Patch Changes
- e64bfb2: Allow defining custom build log transport for techdocs builder
- 8869b8e: Updated local development setup.
- 78a0b08: Internal refactor to handle `BackendFeature` contract change.
- 2110d76: Removed `dockerode` dependency.
- d44a20a: Added additional plugin metadata to `package.json`.
- Updated dependencies
- @backstage/backend-common@0.23.0
- @backstage/backend-plugin-api@0.6.19
- @backstage/plugin-techdocs-node@1.12.5
- @backstage/integration@1.12.0
- @backstage/plugin-search-backend-module-techdocs@0.1.24
- @backstage/plugin-permission-common@0.7.14
- @backstage/plugin-catalog-common@1.0.24
- @backstage/catalog-client@1.6.5
- @backstage/catalog-model@1.5.0
- @backstage/config@1.2.0
- @backstage/errors@1.2.4
## 1.10.6-next.3
### Patch Changes
+2 -2
View File
@@ -3,10 +3,10 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { BackendFeature } from '@backstage/backend-plugin-api';
import { BackendFeatureCompat } from '@backstage/backend-plugin-api';
// @alpha
const techdocsPlugin: () => BackendFeature;
const techdocsPlugin: BackendFeatureCompat;
export default techdocsPlugin;
// (No @packageDocumentation comment for this package)
+1 -3
View File
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-techdocs-backend",
"version": "1.10.6-next.3",
"version": "1.10.6",
"description": "The Backstage backend plugin that renders technical documentation for your components",
"backstage": {
"role": "backend-plugin",
@@ -69,7 +69,6 @@
"@backstage/plugin-search-backend-module-techdocs": "workspace:^",
"@backstage/plugin-techdocs-node": "workspace:^",
"@types/express": "^4.17.6",
"dockerode": "^4.0.0",
"express": "^4.17.1",
"express-promise-router": "^4.1.0",
"fs-extra": "^11.2.0",
@@ -83,7 +82,6 @@
"@backstage/backend-defaults": "workspace:^",
"@backstage/backend-test-utils": "workspace:^",
"@backstage/cli": "workspace:^",
"@types/dockerode": "^3.3.0",
"msw": "^1.0.0",
"supertest": "^6.1.3"
},
-7
View File
@@ -16,7 +16,6 @@
import {
cacheToPluginCacheManager,
DockerContainerRunner,
loggerToWinstonLogger,
} from '@backstage/backend-common';
import {
@@ -36,7 +35,6 @@ import {
techdocsGeneratorExtensionPoint,
techdocsPreparerExtensionPoint,
} from '@backstage/plugin-techdocs-node';
import Docker from 'dockerode';
import { createRouter } from '@backstage/plugin-techdocs-backend';
import * as winston from 'winston';
@@ -118,14 +116,9 @@ export const techdocsPlugin = createBackendPlugin({
preparers.register(protocol, preparer);
}
// Docker client (conditionally) used by the generators, based on techdocs.generators config.
const dockerClient = new Docker();
const containerRunner = new DockerContainerRunner({ dockerClient });
// Generators are used for generating documentation sites.
const generators = await Generators.fromConfig(config, {
logger: winstonLogger,
containerRunner,
customGenerator: customTechdocsGenerator,
});