@backstage/plugin-techdocs-backend 2.4.2-next.2 → 2.4.3

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,5 +1,28 @@
1
1
  # @backstage/plugin-techdocs-backend
2
2
 
3
+ ## 2.4.3
4
+
5
+ ### Patch Changes
6
+
7
+ - 4d7a3fe: Clarified in the config schema which `techdocs.generator.mkdocs` settings also apply to the Zensical engine: `legacyCopyReadmeMdToIndexMd`, `dangerouslyAllowAdditionalKeys` and `dangerouslyAllowAdditionalPlugins`.
8
+ - bc73976: Restricts `markdown_extensions` in `mkdocs.yml` to known extension names before documentation generation, in both the MkDocs and Zensical engines. Extension names outside the permitted set are removed from the configuration with a warning. Allow additional extensions, for example from a custom build image, with the new `techdocs.generator.mkdocs.dangerouslyAllowAdditionalExtensions` configuration, or the `--dangerouslyAllowAdditionalExtensions` flag when using the TechDocs CLI.
9
+ - Updated dependencies
10
+ - @backstage/integration@2.2.0
11
+ - @backstage/catalog-client@1.16.4
12
+ - @backstage/backend-plugin-api@1.12.0
13
+ - @backstage/errors@1.4.0
14
+ - @backstage/plugin-techdocs-node@2.3.0
15
+ - @backstage/catalog-model@1.10.3
16
+ - @backstage/config@1.3.11
17
+ - @backstage/plugin-catalog-node@3.0.0
18
+ - @backstage/plugin-techdocs-common@0.1.3
19
+
20
+ ## 2.4.3-next.2
21
+
22
+ ### Patch Changes
23
+
24
+ - Bumped version to account for a patch release.
25
+
3
26
  ## 2.4.2-next.2
4
27
 
5
28
  ### Patch Changes
@@ -94,6 +94,13 @@
94
94
  },
95
95
  "description": "List of additional MkDocs plugins to allow beyond the default set. Plugins not in this list or the default set will be removed from mkdocs.yml before documentation generation.\n\nWARNING: Some MkDocs plugins can make outbound HTTP requests or execute arbitrary code during documentation generation. Only allow plugins that have been audited for use in your environment, including the configuration options that documentation authors can supply.\n\nAlso applies to the Zensical engine, which reads the same mkdocs.yml, so this configuration will affect both."
96
96
  },
97
+ "dangerouslyAllowAdditionalExtensions": {
98
+ "type": "array",
99
+ "items": {
100
+ "type": "string"
101
+ },
102
+ "description": "List of additional MkDocs markdown extensions to allow beyond the default set. Extensions not in this list or the default set will be removed from mkdocs.yml before documentation generation.\n\nWARNING: Some markdown extensions execute code or load files from the documentation input directory during documentation generation. Only allow extensions that have been audited for use in your environment, including the configuration options that documentation authors can supply.\n\nAlso applies to the Zensical engine, which reads the same mkdocs.yml, so this configuration will affect both."
103
+ },
97
104
  "disableExternalFonts": {
98
105
  "type": "boolean",
99
106
  "description": "Disable external fonts for all TechDocs sites. If not set, the default value is false. If set to true, the external font will be disabled for all TechDocs sites. If set to false, the external font will be enabled for all TechDocs sites."
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-techdocs-backend",
3
- "version": "2.4.2-next.2",
3
+ "version": "2.4.3",
4
4
  "description": "The Backstage backend plugin that renders technical documentation for your components",
5
5
  "backstage": {
6
6
  "role": "backend-plugin",
@@ -75,16 +75,16 @@
75
75
  "test": "backstage-cli package test"
76
76
  },
77
77
  "dependencies": {
78
- "@backstage/backend-plugin-api": "1.12.0-next.1",
79
- "@backstage/catalog-client": "1.16.4-next.1",
80
- "@backstage/catalog-model": "1.10.3-next.0",
81
- "@backstage/config": "1.3.11-next.0",
82
- "@backstage/errors": "1.4.0-next.0",
83
- "@backstage/integration": "2.1.4-next.0",
84
- "@backstage/plugin-catalog-node": "3.0.0-next.2",
85
- "@backstage/plugin-techdocs-common": "0.1.3-next.0",
86
- "@backstage/plugin-techdocs-node": "2.2.1-next.2",
87
- "@backstage/types": "1.2.2",
78
+ "@backstage/backend-plugin-api": "^1.12.0",
79
+ "@backstage/catalog-client": "^1.16.4",
80
+ "@backstage/catalog-model": "^1.10.3",
81
+ "@backstage/config": "^1.3.11",
82
+ "@backstage/errors": "^1.4.0",
83
+ "@backstage/integration": "^2.2.0",
84
+ "@backstage/plugin-catalog-node": "^3.0.0",
85
+ "@backstage/plugin-techdocs-common": "^0.1.3",
86
+ "@backstage/plugin-techdocs-node": "^2.3.0",
87
+ "@backstage/types": "^1.2.2",
88
88
  "express": "^4.22.0",
89
89
  "express-promise-router": "^4.1.0",
90
90
  "fs-extra": "^11.2.0",
@@ -93,13 +93,13 @@
93
93
  "winston": "^3.2.1"
94
94
  },
95
95
  "devDependencies": {
96
- "@backstage/backend-defaults": "0.19.0-next.2",
97
- "@backstage/backend-test-utils": "1.12.0-next.2",
98
- "@backstage/cli": "0.36.8-next.2",
96
+ "@backstage/backend-defaults": "^0.19.0",
97
+ "@backstage/backend-test-utils": "^1.12.0",
98
+ "@backstage/cli": "^0.36.8",
99
99
  "@types/compression": "^1.7.5",
100
100
  "@types/express": "^4.17.6",
101
101
  "compression": "^1.7.4",
102
- "msw": "^2.0.0",
102
+ "msw": "^3.0.4",
103
103
  "supertest": "^7.0.0"
104
104
  },
105
105
  "configSchema": "config.schema.json"