@techdocs/cli 1.10.4 → 1.10.5-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 +21 -0
- package/bin/techdocs-cli +4 -2
- package/dist/commands/generate/generate.cjs.js +1 -1
- package/dist/commands/generate/generate.cjs.js.map +1 -1
- package/dist/commands/publish/publish.cjs.js +1 -1
- package/dist/commands/publish/publish.cjs.js.map +1 -1
- package/dist/commands/serve/serve.cjs.js +1 -1
- package/dist/commands/serve/serve.cjs.js.map +1 -1
- package/dist/embedded-app/.config-schema.json +191 -163
- package/dist/embedded-app/index.html +1 -1
- package/dist/embedded-app/index.html.tmpl +1 -1
- package/dist/embedded-app/static/{1155.b5590627.chunk.js → 1155.7fdf8f74.chunk.js} +2 -2
- package/dist/embedded-app/static/{1155.b5590627.chunk.js.map → 1155.7fdf8f74.chunk.js.map} +1 -1
- package/dist/embedded-app/static/1335.20ce41a6.chunk.js +2 -0
- package/dist/embedded-app/static/1335.20ce41a6.chunk.js.map +1 -0
- package/dist/embedded-app/static/1749.675429c1.chunk.js +2 -0
- package/dist/embedded-app/static/1749.675429c1.chunk.js.map +1 -0
- package/dist/embedded-app/static/1994.2a1755bc.chunk.js +2 -0
- package/dist/embedded-app/static/1994.2a1755bc.chunk.js.map +1 -0
- package/dist/embedded-app/static/2295.4ced0142.chunk.js +5 -0
- package/dist/embedded-app/static/2295.4ced0142.chunk.js.map +1 -0
- package/dist/embedded-app/static/4645.cc59b13f.chunk.js +2 -0
- package/dist/embedded-app/static/{4645.2529d0aa.chunk.js.map → 4645.cc59b13f.chunk.js.map} +1 -1
- package/dist/embedded-app/static/4648.b290d75e.chunk.js +2 -0
- package/dist/embedded-app/static/4648.b290d75e.chunk.js.map +1 -0
- package/dist/embedded-app/static/5495.2e93b457.chunk.js +2 -0
- package/dist/embedded-app/static/5495.2e93b457.chunk.js.map +1 -0
- package/dist/embedded-app/static/6138.48ea9ccb.chunk.js +2 -0
- package/dist/embedded-app/static/6138.48ea9ccb.chunk.js.map +1 -0
- package/dist/embedded-app/static/{6270.e3b38d1d.chunk.js → 6270.9a83c78f.chunk.js} +2 -2
- package/dist/embedded-app/static/{6270.e3b38d1d.chunk.js.map → 6270.9a83c78f.chunk.js.map} +1 -1
- package/dist/embedded-app/static/7186.06700aac.chunk.js +2 -0
- package/dist/embedded-app/static/7186.06700aac.chunk.js.map +1 -0
- package/dist/embedded-app/static/7203.3c95a690.chunk.js +2 -0
- package/dist/embedded-app/static/7203.3c95a690.chunk.js.map +1 -0
- package/dist/embedded-app/static/7382.2d83d2b3.chunk.js +2 -0
- package/dist/embedded-app/static/7382.2d83d2b3.chunk.js.map +1 -0
- package/dist/embedded-app/static/7526.074248a6.chunk.js +2 -0
- package/dist/embedded-app/static/7526.074248a6.chunk.js.map +1 -0
- package/dist/embedded-app/static/8125.71f8d063.chunk.js +7 -0
- package/dist/embedded-app/static/8125.71f8d063.chunk.js.map +1 -0
- package/dist/embedded-app/static/9050.f09397cc.chunk.js +2 -0
- package/dist/embedded-app/static/9050.f09397cc.chunk.js.map +1 -0
- package/dist/embedded-app/static/9230.fb6e1c4a.chunk.js +2 -0
- package/dist/embedded-app/static/9230.fb6e1c4a.chunk.js.map +1 -0
- package/dist/embedded-app/static/9579.060201ba.chunk.js +2 -0
- package/dist/embedded-app/static/9579.060201ba.chunk.js.map +1 -0
- package/dist/embedded-app/static/main.b2329633.css +2 -0
- package/dist/embedded-app/static/main.b2329633.css.map +1 -0
- package/dist/embedded-app/static/main.c9d6fc0d.js +527 -0
- package/dist/embedded-app/static/main.c9d6fc0d.js.map +1 -0
- package/dist/embedded-app/static/{module-date-fns.fe699224.js → module-date-fns.bfd1b82f.js} +2 -2
- package/dist/embedded-app/static/{module-date-fns.fe699224.js.map → module-date-fns.bfd1b82f.js.map} +1 -1
- package/dist/embedded-app/static/module-i18next.c154323c.js +2 -0
- package/dist/embedded-app/static/{module-i18next.685d0b2d.js.map → module-i18next.c154323c.js.map} +1 -1
- package/dist/embedded-app/static/module-lodash.c50623b1.js +2 -0
- package/dist/embedded-app/static/module-lodash.c50623b1.js.map +1 -0
- package/dist/embedded-app/static/module-material-table.40a11f4e.js +2 -0
- package/dist/embedded-app/static/{module-material-table.5a3a2d93.js.map → module-material-table.40a11f4e.js.map} +1 -1
- package/dist/embedded-app/static/module-material-ui.3c48b777.js +2 -0
- package/dist/embedded-app/static/{module-material-ui.9517effb.js.map → module-material-ui.3c48b777.js.map} +1 -1
- package/dist/embedded-app/static/module-mui.c5efba64.js +2 -0
- package/dist/embedded-app/static/{module-mui.375d6d62.js.map → module-mui.c5efba64.js.map} +1 -1
- package/dist/embedded-app/static/{module-react-beautiful-dnd.29de0c3a.js → module-react-beautiful-dnd.6e061f96.js} +2 -2
- package/dist/embedded-app/static/{module-react-beautiful-dnd.29de0c3a.js.map → module-react-beautiful-dnd.6e061f96.js.map} +1 -1
- package/dist/embedded-app/static/module-react-dom.c631e87d.js +2 -0
- package/dist/embedded-app/static/{module-react-dom.44002a3f.js.map → module-react-dom.c631e87d.js.map} +1 -1
- package/dist/embedded-app/static/module-remix-run.d87774b0.js +2 -0
- package/dist/embedded-app/static/{module-remix-run.8b5ff4b7.js.map → module-remix-run.d87774b0.js.map} +1 -1
- package/dist/embedded-app/static/module-zod.c31bff05.js +2 -0
- package/dist/embedded-app/static/{module-zod.4600b494.js.map → module-zod.c31bff05.js.map} +1 -1
- package/dist/embedded-app/static/react-syntax-highlighter/lowlight-import.df3f7284.chunk.js +2 -0
- package/dist/embedded-app/static/react-syntax-highlighter/{lowlight-import.7b0d2cbc.chunk.js.map → lowlight-import.df3f7284.chunk.js.map} +1 -1
- package/dist/embedded-app/static/{runtime.f12aa553.js → runtime.18d1df8a.js} +2 -2
- package/dist/embedded-app/static/{runtime.f12aa553.js.map → runtime.18d1df8a.js.map} +1 -1
- package/dist/embedded-app/static/vendor.e4357869.js +2 -0
- package/dist/embedded-app/static/{vendor.c30d98c8.js.map → vendor.e4357869.js.map} +1 -1
- package/dist/lib/httpServer.cjs.js +1 -1
- package/dist/lib/httpServer.cjs.js.map +1 -1
- package/dist/lib/livereload.cjs.js.map +1 -1
- package/dist/lib/utility.cjs.js +4 -4
- package/dist/lib/utility.cjs.js.map +1 -1
- package/dist/package.json.cjs.js +1 -1
- package/package.json +8 -8
- package/dist/embedded-app/static/1335.18ed80ea.chunk.js +0 -2
- package/dist/embedded-app/static/1335.18ed80ea.chunk.js.map +0 -1
- package/dist/embedded-app/static/1749.12caaf36.chunk.js +0 -2
- package/dist/embedded-app/static/1749.12caaf36.chunk.js.map +0 -1
- package/dist/embedded-app/static/1994.10e5e0a5.chunk.js +0 -2
- package/dist/embedded-app/static/1994.10e5e0a5.chunk.js.map +0 -1
- package/dist/embedded-app/static/2295.ba227b79.chunk.js +0 -5
- package/dist/embedded-app/static/2295.ba227b79.chunk.js.map +0 -1
- package/dist/embedded-app/static/3222.d20eecea.chunk.js +0 -2
- package/dist/embedded-app/static/3222.d20eecea.chunk.js.map +0 -1
- package/dist/embedded-app/static/4645.2529d0aa.chunk.js +0 -2
- package/dist/embedded-app/static/4648.df344fd4.chunk.js +0 -2
- package/dist/embedded-app/static/4648.df344fd4.chunk.js.map +0 -1
- package/dist/embedded-app/static/6138.9fb528c4.chunk.js +0 -2
- package/dist/embedded-app/static/6138.9fb528c4.chunk.js.map +0 -1
- package/dist/embedded-app/static/7186.0b7e4914.chunk.js +0 -2
- package/dist/embedded-app/static/7186.0b7e4914.chunk.js.map +0 -1
- package/dist/embedded-app/static/7203.c157eeae.chunk.js +0 -2
- package/dist/embedded-app/static/7203.c157eeae.chunk.js.map +0 -1
- package/dist/embedded-app/static/7382.75824f8e.chunk.js +0 -2
- package/dist/embedded-app/static/7382.75824f8e.chunk.js.map +0 -1
- package/dist/embedded-app/static/7526.dd1429dd.chunk.js +0 -2
- package/dist/embedded-app/static/7526.dd1429dd.chunk.js.map +0 -1
- package/dist/embedded-app/static/8125.b12aec21.chunk.js +0 -7
- package/dist/embedded-app/static/8125.b12aec21.chunk.js.map +0 -1
- package/dist/embedded-app/static/9050.21dcd5d1.chunk.js +0 -2
- package/dist/embedded-app/static/9050.21dcd5d1.chunk.js.map +0 -1
- package/dist/embedded-app/static/9230.885db42d.chunk.js +0 -2
- package/dist/embedded-app/static/9230.885db42d.chunk.js.map +0 -1
- package/dist/embedded-app/static/9579.84d1dba2.chunk.js +0 -2
- package/dist/embedded-app/static/9579.84d1dba2.chunk.js.map +0 -1
- package/dist/embedded-app/static/main.0c6dd09c.css +0 -2
- package/dist/embedded-app/static/main.0c6dd09c.css.map +0 -1
- package/dist/embedded-app/static/main.bd200dfa.js +0 -550
- package/dist/embedded-app/static/main.bd200dfa.js.map +0 -1
- package/dist/embedded-app/static/module-i18next.685d0b2d.js +0 -2
- package/dist/embedded-app/static/module-lodash.7d4f904e.js +0 -2
- package/dist/embedded-app/static/module-lodash.7d4f904e.js.map +0 -1
- package/dist/embedded-app/static/module-material-table.5a3a2d93.js +0 -2
- package/dist/embedded-app/static/module-material-ui.9517effb.js +0 -2
- package/dist/embedded-app/static/module-mui.375d6d62.js +0 -2
- package/dist/embedded-app/static/module-react-dom.44002a3f.js +0 -2
- package/dist/embedded-app/static/module-remix-run.8b5ff4b7.js +0 -2
- package/dist/embedded-app/static/module-zod.4600b494.js +0 -2
- package/dist/embedded-app/static/react-syntax-highlighter/lowlight-import.7b0d2cbc.chunk.js +0 -2
- package/dist/embedded-app/static/vendor.c30d98c8.js +0 -2
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,26 @@
|
|
|
1
1
|
# @techdocs/cli
|
|
2
2
|
|
|
3
|
+
## 1.10.5-next.1
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 508d127: Updated dependency `find-process` to `^2.0.0`.
|
|
8
|
+
- Updated dependencies
|
|
9
|
+
- @backstage/backend-defaults@0.15.2-next.1
|
|
10
|
+
- @backstage/plugin-techdocs-node@1.14.2-next.1
|
|
11
|
+
|
|
12
|
+
## 1.10.5-next.0
|
|
13
|
+
|
|
14
|
+
### Patch Changes
|
|
15
|
+
|
|
16
|
+
- 7455dae: Use node prefix on native imports
|
|
17
|
+
- Updated dependencies
|
|
18
|
+
- @backstage/backend-defaults@0.15.1-next.0
|
|
19
|
+
- @backstage/plugin-techdocs-node@1.14.1-next.0
|
|
20
|
+
- @backstage/cli-common@0.1.18-next.0
|
|
21
|
+
- @backstage/catalog-model@1.7.6
|
|
22
|
+
- @backstage/config@1.3.6
|
|
23
|
+
|
|
3
24
|
## 1.10.4
|
|
4
25
|
|
|
5
26
|
### Patch Changes
|
package/bin/techdocs-cli
CHANGED
|
@@ -15,11 +15,13 @@
|
|
|
15
15
|
* limitations under the License.
|
|
16
16
|
*/
|
|
17
17
|
|
|
18
|
-
const path = require('path');
|
|
18
|
+
const path = require('node:path');
|
|
19
19
|
|
|
20
20
|
// Figure out whether we're running inside the backstage repo or as an installed dependency
|
|
21
21
|
/* eslint-disable-next-line no-restricted-syntax */
|
|
22
|
-
const isLocal = require('fs').existsSync(
|
|
22
|
+
const isLocal = require('node:fs').existsSync(
|
|
23
|
+
path.resolve(__dirname, '../src'),
|
|
24
|
+
);
|
|
23
25
|
|
|
24
26
|
if (!isLocal) {
|
|
25
27
|
require('..');
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Object.defineProperty(exports, '__esModule', { value: true });
|
|
4
4
|
|
|
5
|
-
var path = require('path');
|
|
5
|
+
var path = require('node:path');
|
|
6
6
|
var fs = require('fs-extra');
|
|
7
7
|
var pluginTechdocsNode = require('@backstage/plugin-techdocs-node');
|
|
8
8
|
var config = require('@backstage/config');
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"generate.cjs.js","sources":["../../../src/commands/generate/generate.ts"],"sourcesContent":["/*\n * Copyright 2020 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 { resolve } from 'path';\nimport { OptionValues } from 'commander';\nimport fs from 'fs-extra';\nimport {\n TechdocsGenerator,\n ParsedLocationAnnotation,\n getMkdocsYml,\n} from '@backstage/plugin-techdocs-node';\nimport { ConfigReader } from '@backstage/config';\nimport {\n convertTechDocsRefToLocationAnnotation,\n createLogger,\n getLogStream,\n} from '../../lib/utility';\n\nexport default async function generate(opts: OptionValues) {\n // Use techdocs-node package to generate docs. Keep consistency between Backstage and CI generating docs.\n // Docs can be prepared using actions/checkout or git clone, or similar paradigms on CI. The TechDocs CI workflow\n // will run on the CI pipeline containing the documentation files.\n\n const logger = createLogger({ verbose: opts.verbose });\n\n const sourceDir = resolve(opts.sourceDir);\n const outputDir = resolve(opts.outputDir);\n const omitTechdocsCorePlugin = opts.omitTechdocsCoreMkdocsPlugin;\n const dockerImage = opts.dockerImage;\n const pullImage = opts.pull;\n const legacyCopyReadmeMdToIndexMd = opts.legacyCopyReadmeMdToIndexMd;\n const defaultPlugins = opts.defaultPlugin;\n\n logger.info(`Using source dir ${sourceDir}`);\n logger.info(`Will output generated files in ${outputDir}`);\n\n logger.verbose('Creating output directory if it does not exist.');\n\n await fs.ensureDir(outputDir);\n\n const { path: mkdocsYmlPath, configIsTemporary } = await getMkdocsYml(\n sourceDir,\n );\n\n const config = new ConfigReader({\n techdocs: {\n generator: {\n runIn: opts.docker ? 'docker' : 'local',\n dockerImage,\n pullImage,\n mkdocs: {\n legacyCopyReadmeMdToIndexMd,\n omitTechdocsCorePlugin,\n defaultPlugins,\n },\n },\n },\n });\n\n let parsedLocationAnnotation = {} as ParsedLocationAnnotation;\n if (opts.techdocsRef) {\n try {\n parsedLocationAnnotation = convertTechDocsRefToLocationAnnotation(\n opts.techdocsRef,\n );\n } catch (err) {\n logger.error(err.message);\n }\n }\n\n // Generate docs using @backstage/plugin-techdocs-node\n const techdocsGenerator = await TechdocsGenerator.fromConfig(config, {\n logger,\n });\n\n logger.info('Generating documentation...');\n\n await techdocsGenerator.run({\n inputDir: sourceDir,\n outputDir,\n ...(opts.techdocsRef\n ? {\n parsedLocationAnnotation,\n }\n : {}),\n logger,\n etag: opts.etag,\n logStream: getLogStream(logger),\n siteOptions: { name: opts.siteName },\n runAsDefaultUser: opts.runAsDefaultUser,\n });\n\n if (configIsTemporary) {\n process.on('exit', async () => {\n fs.rmSync(mkdocsYmlPath, {});\n });\n }\n\n logger.info('Done!');\n}\n"],"names":["createLogger","resolve","fs","getMkdocsYml","config","ConfigReader","convertTechDocsRefToLocationAnnotation","TechdocsGenerator","getLogStream"],"mappings":";;;;;;;;;;;;;;AA+BA,eAA8B,SAAS,IAAA,EAAoB;AAKzD,EAAA,MAAM,SAASA,oBAAA,CAAa,EAAE,OAAA,EAAS,IAAA,CAAK,SAAS,CAAA;AAErD,EAAA,MAAM,SAAA,GAAYC,YAAA,CAAQ,IAAA,CAAK,SAAS,CAAA;AACxC,EAAA,MAAM,SAAA,GAAYA,YAAA,CAAQ,IAAA,CAAK,SAAS,CAAA;AACxC,EAAA,MAAM,yBAAyB,IAAA,CAAK,4BAAA;AACpC,EAAA,MAAM,cAAc,IAAA,CAAK,WAAA;AACzB,EAAA,MAAM,YAAY,IAAA,CAAK,IAAA;AACvB,EAAA,MAAM,8BAA8B,IAAA,CAAK,2BAAA;AACzC,EAAA,MAAM,iBAAiB,IAAA,CAAK,aAAA;AAE5B,EAAA,MAAA,CAAO,IAAA,CAAK,CAAA,iBAAA,EAAoB,SAAS,CAAA,CAAE,CAAA;AAC3C,EAAA,MAAA,CAAO,IAAA,CAAK,CAAA,+BAAA,EAAkC,SAAS,CAAA,CAAE,CAAA;AAEzD,EAAA,MAAA,CAAO,QAAQ,iDAAiD,CAAA;AAEhE,EAAA,MAAMC,mBAAA,CAAG,UAAU,SAAS,CAAA;AAE5B,EAAA,MAAM,EAAE,IAAA,EAAM,aAAA,EAAe,iBAAA,KAAsB,MAAMC,+BAAA;AAAA,IACvD;AAAA,GACF;AAEA,EAAA,MAAMC,QAAA,GAAS,IAAIC,mBAAA,CAAa;AAAA,IAC9B,QAAA,EAAU;AAAA,MACR,SAAA,EAAW;AAAA,QACT,KAAA,EAAO,IAAA,CAAK,MAAA,GAAS,QAAA,GAAW,OAAA;AAAA,QAChC,WAAA;AAAA,QACA,SAAA;AAAA,QACA,MAAA,EAAQ;AAAA,UACN,2BAAA;AAAA,UACA,sBAAA;AAAA,UACA;AAAA;AACF;AACF;AACF,GACD,CAAA;AAED,EAAA,IAAI,2BAA2B,EAAC;AAChC,EAAA,IAAI,KAAK,WAAA,EAAa;AACpB,IAAA,IAAI;AACF,MAAA,wBAAA,GAA2BC,8CAAA;AAAA,QACzB,IAAA,CAAK;AAAA,OACP;AAAA,IACF,SAAS,GAAA,EAAK;AACZ,MAAA,MAAA,CAAO,KAAA,CAAM,IAAI,OAAO,CAAA;AAAA,IAC1B;AAAA,EACF;AAGA,EAAA,MAAM,iBAAA,GAAoB,MAAMC,oCAAA,CAAkB,UAAA,CAAWH,QAAA,EAAQ;AAAA,IACnE;AAAA,GACD,CAAA;AAED,EAAA,MAAA,CAAO,KAAK,6BAA6B,CAAA;AAEzC,EAAA,MAAM,kBAAkB,GAAA,CAAI;AAAA,IAC1B,QAAA,EAAU,SAAA;AAAA,IACV,SAAA;AAAA,IACA,GAAI,KAAK,WAAA,GACL;AAAA,MACE;AAAA,QAEF,EAAC;AAAA,IACL,MAAA;AAAA,IACA,MAAM,IAAA,CAAK,IAAA;AAAA,IACX,SAAA,EAAWI,qBAAa,MAAM,CAAA;AAAA,IAC9B,WAAA,EAAa,EAAE,IAAA,EAAM,IAAA,CAAK,QAAA,EAAS;AAAA,IACnC,kBAAkB,IAAA,CAAK;AAAA,GACxB,CAAA;AAED,EAAA,IAAI,iBAAA,EAAmB;AACrB,IAAA,OAAA,CAAQ,EAAA,CAAG,QAAQ,YAAY;AAC7B,MAAAN,mBAAA,CAAG,MAAA,CAAO,aAAA,EAAe,EAAE,CAAA;AAAA,IAC7B,CAAC,CAAA;AAAA,EACH;AAEA,EAAA,MAAA,CAAO,KAAK,OAAO,CAAA;AACrB;;;;"}
|
|
1
|
+
{"version":3,"file":"generate.cjs.js","sources":["../../../src/commands/generate/generate.ts"],"sourcesContent":["/*\n * Copyright 2020 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 { resolve } from 'node:path';\nimport { OptionValues } from 'commander';\nimport fs from 'fs-extra';\nimport {\n TechdocsGenerator,\n ParsedLocationAnnotation,\n getMkdocsYml,\n} from '@backstage/plugin-techdocs-node';\nimport { ConfigReader } from '@backstage/config';\nimport {\n convertTechDocsRefToLocationAnnotation,\n createLogger,\n getLogStream,\n} from '../../lib/utility';\n\nexport default async function generate(opts: OptionValues) {\n // Use techdocs-node package to generate docs. Keep consistency between Backstage and CI generating docs.\n // Docs can be prepared using actions/checkout or git clone, or similar paradigms on CI. The TechDocs CI workflow\n // will run on the CI pipeline containing the documentation files.\n\n const logger = createLogger({ verbose: opts.verbose });\n\n const sourceDir = resolve(opts.sourceDir);\n const outputDir = resolve(opts.outputDir);\n const omitTechdocsCorePlugin = opts.omitTechdocsCoreMkdocsPlugin;\n const dockerImage = opts.dockerImage;\n const pullImage = opts.pull;\n const legacyCopyReadmeMdToIndexMd = opts.legacyCopyReadmeMdToIndexMd;\n const defaultPlugins = opts.defaultPlugin;\n\n logger.info(`Using source dir ${sourceDir}`);\n logger.info(`Will output generated files in ${outputDir}`);\n\n logger.verbose('Creating output directory if it does not exist.');\n\n await fs.ensureDir(outputDir);\n\n const { path: mkdocsYmlPath, configIsTemporary } = await getMkdocsYml(\n sourceDir,\n );\n\n const config = new ConfigReader({\n techdocs: {\n generator: {\n runIn: opts.docker ? 'docker' : 'local',\n dockerImage,\n pullImage,\n mkdocs: {\n legacyCopyReadmeMdToIndexMd,\n omitTechdocsCorePlugin,\n defaultPlugins,\n },\n },\n },\n });\n\n let parsedLocationAnnotation = {} as ParsedLocationAnnotation;\n if (opts.techdocsRef) {\n try {\n parsedLocationAnnotation = convertTechDocsRefToLocationAnnotation(\n opts.techdocsRef,\n );\n } catch (err) {\n logger.error(err.message);\n }\n }\n\n // Generate docs using @backstage/plugin-techdocs-node\n const techdocsGenerator = await TechdocsGenerator.fromConfig(config, {\n logger,\n });\n\n logger.info('Generating documentation...');\n\n await techdocsGenerator.run({\n inputDir: sourceDir,\n outputDir,\n ...(opts.techdocsRef\n ? {\n parsedLocationAnnotation,\n }\n : {}),\n logger,\n etag: opts.etag,\n logStream: getLogStream(logger),\n siteOptions: { name: opts.siteName },\n runAsDefaultUser: opts.runAsDefaultUser,\n });\n\n if (configIsTemporary) {\n process.on('exit', async () => {\n fs.rmSync(mkdocsYmlPath, {});\n });\n }\n\n logger.info('Done!');\n}\n"],"names":["createLogger","resolve","fs","getMkdocsYml","config","ConfigReader","convertTechDocsRefToLocationAnnotation","TechdocsGenerator","getLogStream"],"mappings":";;;;;;;;;;;;;;AA+BA,eAA8B,SAAS,IAAA,EAAoB;AAKzD,EAAA,MAAM,SAASA,oBAAA,CAAa,EAAE,OAAA,EAAS,IAAA,CAAK,SAAS,CAAA;AAErD,EAAA,MAAM,SAAA,GAAYC,YAAA,CAAQ,IAAA,CAAK,SAAS,CAAA;AACxC,EAAA,MAAM,SAAA,GAAYA,YAAA,CAAQ,IAAA,CAAK,SAAS,CAAA;AACxC,EAAA,MAAM,yBAAyB,IAAA,CAAK,4BAAA;AACpC,EAAA,MAAM,cAAc,IAAA,CAAK,WAAA;AACzB,EAAA,MAAM,YAAY,IAAA,CAAK,IAAA;AACvB,EAAA,MAAM,8BAA8B,IAAA,CAAK,2BAAA;AACzC,EAAA,MAAM,iBAAiB,IAAA,CAAK,aAAA;AAE5B,EAAA,MAAA,CAAO,IAAA,CAAK,CAAA,iBAAA,EAAoB,SAAS,CAAA,CAAE,CAAA;AAC3C,EAAA,MAAA,CAAO,IAAA,CAAK,CAAA,+BAAA,EAAkC,SAAS,CAAA,CAAE,CAAA;AAEzD,EAAA,MAAA,CAAO,QAAQ,iDAAiD,CAAA;AAEhE,EAAA,MAAMC,mBAAA,CAAG,UAAU,SAAS,CAAA;AAE5B,EAAA,MAAM,EAAE,IAAA,EAAM,aAAA,EAAe,iBAAA,KAAsB,MAAMC,+BAAA;AAAA,IACvD;AAAA,GACF;AAEA,EAAA,MAAMC,QAAA,GAAS,IAAIC,mBAAA,CAAa;AAAA,IAC9B,QAAA,EAAU;AAAA,MACR,SAAA,EAAW;AAAA,QACT,KAAA,EAAO,IAAA,CAAK,MAAA,GAAS,QAAA,GAAW,OAAA;AAAA,QAChC,WAAA;AAAA,QACA,SAAA;AAAA,QACA,MAAA,EAAQ;AAAA,UACN,2BAAA;AAAA,UACA,sBAAA;AAAA,UACA;AAAA;AACF;AACF;AACF,GACD,CAAA;AAED,EAAA,IAAI,2BAA2B,EAAC;AAChC,EAAA,IAAI,KAAK,WAAA,EAAa;AACpB,IAAA,IAAI;AACF,MAAA,wBAAA,GAA2BC,8CAAA;AAAA,QACzB,IAAA,CAAK;AAAA,OACP;AAAA,IACF,SAAS,GAAA,EAAK;AACZ,MAAA,MAAA,CAAO,KAAA,CAAM,IAAI,OAAO,CAAA;AAAA,IAC1B;AAAA,EACF;AAGA,EAAA,MAAM,iBAAA,GAAoB,MAAMC,oCAAA,CAAkB,UAAA,CAAWH,QAAA,EAAQ;AAAA,IACnE;AAAA,GACD,CAAA;AAED,EAAA,MAAA,CAAO,KAAK,6BAA6B,CAAA;AAEzC,EAAA,MAAM,kBAAkB,GAAA,CAAI;AAAA,IAC1B,QAAA,EAAU,SAAA;AAAA,IACV,SAAA;AAAA,IACA,GAAI,KAAK,WAAA,GACL;AAAA,MACE;AAAA,QAEF,EAAC;AAAA,IACL,MAAA;AAAA,IACA,MAAM,IAAA,CAAK,IAAA;AAAA,IACX,SAAA,EAAWI,qBAAa,MAAM,CAAA;AAAA,IAC9B,WAAA,EAAa,EAAE,IAAA,EAAM,IAAA,CAAK,QAAA,EAAS;AAAA,IACnC,kBAAkB,IAAA,CAAK;AAAA,GACxB,CAAA;AAED,EAAA,IAAI,iBAAA,EAAmB;AACrB,IAAA,OAAA,CAAQ,EAAA,CAAG,QAAQ,YAAY;AAC7B,MAAAN,mBAAA,CAAG,MAAA,CAAO,aAAA,EAAe,EAAE,CAAA;AAAA,IAC7B,CAAC,CAAA;AAAA,EACH;AAEA,EAAA,MAAA,CAAO,KAAK,OAAO,CAAA;AACrB;;;;"}
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Object.defineProperty(exports, '__esModule', { value: true });
|
|
4
4
|
|
|
5
|
-
var path = require('path');
|
|
5
|
+
var path = require('node:path');
|
|
6
6
|
var utility = require('../../lib/utility.cjs.js');
|
|
7
7
|
var discovery = require('@backstage/backend-defaults/discovery');
|
|
8
8
|
var pluginTechdocsNode = require('@backstage/plugin-techdocs-node');
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"publish.cjs.js","sources":["../../../src/commands/publish/publish.ts"],"sourcesContent":["/*\n * Copyright 2020 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 { resolve } from 'path';\nimport { OptionValues } from 'commander';\nimport { createLogger } from '../../lib/utility';\nimport { HostDiscovery } from '@backstage/backend-defaults/discovery';\nimport { Publisher } from '@backstage/plugin-techdocs-node';\nimport { Entity } from '@backstage/catalog-model';\nimport { PublisherConfig } from '../../lib/PublisherConfig';\n\nexport default async function publish(opts: OptionValues): Promise<any> {\n const logger = createLogger({ verbose: opts.verbose });\n\n const config = PublisherConfig.getValidConfig(opts);\n const discovery = HostDiscovery.fromConfig(config);\n const publisher = await Publisher.fromConfig(config, { logger, discovery });\n\n // Check that the publisher's underlying storage is ready and available.\n const { isAvailable } = await publisher.getReadiness();\n if (!isAvailable) {\n // Error messages printed in getReadiness() call. This ensures exit code 1.\n return Promise.reject(new Error(''));\n }\n\n const [namespace, kind, name] = opts.entity.split('/');\n const entity = {\n kind,\n metadata: {\n namespace,\n name,\n },\n } as Entity;\n\n const directory = resolve(opts.directory);\n await publisher.publish({ entity, directory });\n\n return true;\n}\n"],"names":["createLogger","PublisherConfig","discovery","HostDiscovery","Publisher","resolve"],"mappings":";;;;;;;;;;AAwBA,eAA8B,QAAQ,IAAA,EAAkC;AACtE,EAAA,MAAM,SAASA,oBAAA,CAAa,EAAE,OAAA,EAAS,IAAA,CAAK,SAAS,CAAA;AAErD,EAAA,MAAM,MAAA,GAASC,+BAAA,CAAgB,cAAA,CAAe,IAAI,CAAA;AAClD,EAAA,MAAMC,WAAA,GAAYC,uBAAA,CAAc,UAAA,CAAW,MAAM,CAAA;AACjD,EAAA,MAAM,SAAA,GAAY,MAAMC,4BAAA,CAAU,UAAA,CAAW,QAAQ,EAAE,MAAA,aAAQF,aAAW,CAAA;AAG1E,EAAA,MAAM,EAAE,WAAA,EAAY,GAAI,MAAM,UAAU,YAAA,EAAa;AACrD,EAAA,IAAI,CAAC,WAAA,EAAa;AAEhB,IAAA,OAAO,OAAA,CAAQ,MAAA,CAAO,IAAI,KAAA,CAAM,EAAE,CAAC,CAAA;AAAA,EACrC;AAEA,EAAA,MAAM,CAAC,WAAW,IAAA,EAAM,IAAI,IAAI,IAAA,CAAK,MAAA,CAAO,MAAM,GAAG,CAAA;AACrD,EAAA,MAAM,MAAA,GAAS;AAAA,IACb,IAAA;AAAA,IACA,QAAA,EAAU;AAAA,MACR,SAAA;AAAA,MACA;AAAA;AACF,GACF;AAEA,EAAA,MAAM,SAAA,GAAYG,YAAA,CAAQ,IAAA,CAAK,SAAS,CAAA;AACxC,EAAA,MAAM,SAAA,CAAU,OAAA,CAAQ,EAAE,MAAA,EAAQ,WAAW,CAAA;AAE7C,EAAA,OAAO,IAAA;AACT;;;;"}
|
|
1
|
+
{"version":3,"file":"publish.cjs.js","sources":["../../../src/commands/publish/publish.ts"],"sourcesContent":["/*\n * Copyright 2020 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 { resolve } from 'node:path';\nimport { OptionValues } from 'commander';\nimport { createLogger } from '../../lib/utility';\nimport { HostDiscovery } from '@backstage/backend-defaults/discovery';\nimport { Publisher } from '@backstage/plugin-techdocs-node';\nimport { Entity } from '@backstage/catalog-model';\nimport { PublisherConfig } from '../../lib/PublisherConfig';\n\nexport default async function publish(opts: OptionValues): Promise<any> {\n const logger = createLogger({ verbose: opts.verbose });\n\n const config = PublisherConfig.getValidConfig(opts);\n const discovery = HostDiscovery.fromConfig(config);\n const publisher = await Publisher.fromConfig(config, { logger, discovery });\n\n // Check that the publisher's underlying storage is ready and available.\n const { isAvailable } = await publisher.getReadiness();\n if (!isAvailable) {\n // Error messages printed in getReadiness() call. This ensures exit code 1.\n return Promise.reject(new Error(''));\n }\n\n const [namespace, kind, name] = opts.entity.split('/');\n const entity = {\n kind,\n metadata: {\n namespace,\n name,\n },\n } as Entity;\n\n const directory = resolve(opts.directory);\n await publisher.publish({ entity, directory });\n\n return true;\n}\n"],"names":["createLogger","PublisherConfig","discovery","HostDiscovery","Publisher","resolve"],"mappings":";;;;;;;;;;AAwBA,eAA8B,QAAQ,IAAA,EAAkC;AACtE,EAAA,MAAM,SAASA,oBAAA,CAAa,EAAE,OAAA,EAAS,IAAA,CAAK,SAAS,CAAA;AAErD,EAAA,MAAM,MAAA,GAASC,+BAAA,CAAgB,cAAA,CAAe,IAAI,CAAA;AAClD,EAAA,MAAMC,WAAA,GAAYC,uBAAA,CAAc,UAAA,CAAW,MAAM,CAAA;AACjD,EAAA,MAAM,SAAA,GAAY,MAAMC,4BAAA,CAAU,UAAA,CAAW,QAAQ,EAAE,MAAA,aAAQF,aAAW,CAAA;AAG1E,EAAA,MAAM,EAAE,WAAA,EAAY,GAAI,MAAM,UAAU,YAAA,EAAa;AACrD,EAAA,IAAI,CAAC,WAAA,EAAa;AAEhB,IAAA,OAAO,OAAA,CAAQ,MAAA,CAAO,IAAI,KAAA,CAAM,EAAE,CAAC,CAAA;AAAA,EACrC;AAEA,EAAA,MAAM,CAAC,WAAW,IAAA,EAAM,IAAI,IAAI,IAAA,CAAK,MAAA,CAAO,MAAM,GAAG,CAAA;AACrD,EAAA,MAAM,MAAA,GAAS;AAAA,IACb,IAAA;AAAA,IACA,QAAA,EAAU;AAAA,MACR,SAAA;AAAA,MACA;AAAA;AACF,GACF;AAEA,EAAA,MAAM,SAAA,GAAYG,YAAA,CAAQ,IAAA,CAAK,SAAS,CAAA;AACxC,EAAA,MAAM,SAAA,CAAU,OAAA,CAAQ,EAAE,MAAA,EAAQ,WAAW,CAAA;AAE7C,EAAA,OAAO,IAAA;AACT;;;;"}
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Object.defineProperty(exports, '__esModule', { value: true });
|
|
4
4
|
|
|
5
|
-
var path = require('path');
|
|
5
|
+
var path = require('node:path');
|
|
6
6
|
var openBrowser = require('react-dev-utils/openBrowser');
|
|
7
7
|
var cliCommon = require('@backstage/cli-common');
|
|
8
8
|
var httpServer = require('../../lib/httpServer.cjs.js');
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"serve.cjs.js","sources":["../../../src/commands/serve/serve.ts"],"sourcesContent":["/*\n * Copyright 2020 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 { OptionValues } from 'commander';\nimport path from 'path';\nimport openBrowser from 'react-dev-utils/openBrowser';\nimport { findPaths, RunOnOutput } from '@backstage/cli-common';\nimport HTTPServer from '../../lib/httpServer';\nimport { runMkdocsServer } from '../../lib/mkdocsServer';\nimport { createLogger } from '../../lib/utility';\nimport { getMkdocsYml } from '@backstage/plugin-techdocs-node';\nimport fs from 'fs-extra';\nimport { checkIfDockerIsOperational } from './utils';\n\nfunction findPreviewBundlePath(): string {\n try {\n return path.join(\n path.dirname(require.resolve('techdocs-cli-embedded-app/package.json')),\n 'dist',\n );\n } catch {\n // If the techdocs-cli-embedded-app package is not available it means we're\n // running a published package. For published packages the preview bundle is\n // copied to dist/embedded-app be the prepack script.\n //\n // This can be tested by running `yarn pack` and extracting the resulting tarball into a directory.\n // Within the extracted directory, run `npm install --only=prod`.\n // Once that's done you can test the CLI in any directory using `node <tmp-dir>/package <command>`.\n // eslint-disable-next-line no-restricted-syntax\n return findPaths(__dirname).resolveOwn('dist/embedded-app');\n }\n}\n\nfunction getPreviewAppPath(opts: OptionValues): string {\n return opts.previewAppBundlePath ?? findPreviewBundlePath();\n}\n\nexport default async function serve(opts: OptionValues) {\n const logger = createLogger({ verbose: opts.verbose });\n\n // Determine if we want to run in local dev mode or not\n // This will run the backstage http server on a different port and only used\n // for proxying mkdocs to the backstage app running locally (e.g. with webpack-dev-server)\n const isDevMode = Object.keys(process.env).includes('TECHDOCS_CLI_DEV_MODE')\n ? true\n : false;\n\n const backstageBackendPort = 7007;\n\n const mkdocsDockerAddr = `http://0.0.0.0:${opts.mkdocsPort}`;\n const mkdocsLocalAddr = `http://127.0.0.1:${opts.mkdocsPort}`;\n const mkdocsExpectedDevAddr = opts.docker\n ? mkdocsDockerAddr\n : mkdocsLocalAddr;\n const mkdocsConfigFileName = opts.mkdocsConfigFileName;\n const siteName = opts.siteName;\n\n const { path: mkdocsYmlPath, configIsTemporary } = await getMkdocsYml('./', {\n name: siteName,\n mkdocsConfigFileName,\n });\n\n // Validate that Docker is up and running\n if (opts.docker) {\n const isDockerOperational = await checkIfDockerIsOperational(logger);\n if (!isDockerOperational) {\n return;\n }\n }\n\n let mkdocsServerHasStarted = false;\n const mkdocsLogFunc: RunOnOutput = data => {\n // Sometimes the lines contain an unnecessary extra new line\n const logLines = data.toString().split('\\n');\n const logPrefix = opts.docker ? '[docker/mkdocs]' : '[mkdocs]';\n logLines.forEach(line => {\n if (line === '') {\n return;\n }\n\n logger.verbose(`${logPrefix} ${line}`);\n\n // When the server has started, open a new browser tab for the user.\n if (\n !mkdocsServerHasStarted &&\n line.includes(`Serving on ${mkdocsExpectedDevAddr}`)\n ) {\n mkdocsServerHasStarted = true;\n }\n });\n };\n // mkdocs writes all of its logs to stderr by default, and not stdout.\n // https://github.com/mkdocs/mkdocs/issues/879#issuecomment-203536006\n // Had me questioning this whole implementation for half an hour.\n logger.info('Starting mkdocs server.');\n const mkdocsChildProcess = runMkdocsServer({\n port: opts.mkdocsPort,\n dockerImage: opts.dockerImage,\n dockerEntrypoint: opts.dockerEntrypoint,\n dockerOptions: opts.dockerOption,\n useDocker: opts.docker,\n onStdout: mkdocsLogFunc,\n onStderr: mkdocsLogFunc,\n mkdocsConfigFileName: mkdocsYmlPath,\n mkdocsParameterClean: opts.mkdocsParameterClean,\n mkdocsParameterDirtyReload: opts.mkdocsParameterDirtyreload,\n mkdocsParameterStrict: opts.mkdocsParameterStrict,\n });\n\n // Wait until mkdocs server has started so that Backstage starts with docs loaded\n // Takes 1-5 seconds\n for (let attempt = 0; attempt < 30; attempt++) {\n await new Promise(r => setTimeout(r, 3000));\n if (mkdocsServerHasStarted) {\n break;\n }\n logger.info('Waiting for mkdocs server to start...');\n }\n\n if (!mkdocsServerHasStarted) {\n logger.error(\n 'mkdocs server did not start. Exiting. Try re-running command with -v option for more details.',\n );\n }\n\n const port = isDevMode ? backstageBackendPort : opts.previewAppPort;\n const previewAppPath = getPreviewAppPath(opts);\n const httpServer = new HTTPServer(\n previewAppPath,\n port,\n mkdocsExpectedDevAddr,\n opts.verbose,\n );\n\n httpServer\n .serve()\n .catch(err => {\n logger.error('Failed to start HTTP server', err);\n mkdocsChildProcess.kill();\n process.exit(1);\n })\n .then(() => {\n // The last three things default/component/local/ don't matter. They can be anything.\n openBrowser(`http://localhost:${port}/docs/default/component/local/`);\n logger.info(\n `Serving docs in Backstage at http://localhost:${port}/docs/default/component/local/\\nOpening browser.`,\n );\n });\n\n await mkdocsChildProcess.waitForExit();\n\n if (configIsTemporary) {\n process.on('exit', async () => {\n fs.rmSync(mkdocsYmlPath, {});\n });\n }\n}\n"],"names":["path","findPaths","createLogger","getMkdocsYml","checkIfDockerIsOperational","runMkdocsServer","httpServer","HTTPServer","openBrowser","fs"],"mappings":";;;;;;;;;;;;;;;;;;;;AA2BA,SAAS,qBAAA,GAAgC;AACvC,EAAA,IAAI;AACF,IAAA,OAAOA,qBAAA,CAAK,IAAA;AAAA,MACVA,qBAAA,CAAK,OAAA,CAAQ,OAAA,CAAQ,OAAA,CAAQ,wCAAwC,CAAC,CAAA;AAAA,MACtE;AAAA,KACF;AAAA,EACF,CAAA,CAAA,MAAQ;AASN,IAAA,OAAOC,mBAAA,CAAU,SAAS,CAAA,CAAE,UAAA,CAAW,mBAAmB,CAAA;AAAA,EAC5D;AACF;AAEA,SAAS,kBAAkB,IAAA,EAA4B;AACrD,EAAA,OAAO,IAAA,CAAK,wBAAwB,qBAAA,EAAsB;AAC5D;AAEA,eAA8B,MAAM,IAAA,EAAoB;AACtD,EAAA,MAAM,SAASC,oBAAA,CAAa,EAAE,OAAA,EAAS,IAAA,CAAK,SAAS,CAAA;AAKrD,EAAA,MAAM,SAAA,GAAY,OAAO,IAAA,CAAK,OAAA,CAAQ,GAAG,CAAA,CAAE,QAAA,CAAS,uBAAuB,CAAA,GACvE,IAAA,GACA,KAAA;AAEJ,EAAA,MAAM,oBAAA,GAAuB,IAAA;AAE7B,EAAA,MAAM,gBAAA,GAAmB,CAAA,eAAA,EAAkB,IAAA,CAAK,UAAU,CAAA,CAAA;AAC1D,EAAA,MAAM,eAAA,GAAkB,CAAA,iBAAA,EAAoB,IAAA,CAAK,UAAU,CAAA,CAAA;AAC3D,EAAA,MAAM,qBAAA,GAAwB,IAAA,CAAK,MAAA,GAC/B,gBAAA,GACA,eAAA;AACJ,EAAA,MAAM,uBAAuB,IAAA,CAAK,oBAAA;AAClC,EAAA,MAAM,WAAW,IAAA,CAAK,QAAA;AAEtB,EAAA,MAAM,EAAE,IAAA,EAAM,aAAA,EAAe,mBAAkB,GAAI,MAAMC,gCAAa,IAAA,EAAM;AAAA,IAC1E,IAAA,EAAM,QAAA;AAAA,IACN;AAAA,GACD,CAAA;AAGD,EAAA,IAAI,KAAK,MAAA,EAAQ;AACf,IAAA,MAAM,mBAAA,GAAsB,MAAMC,gCAAA,CAA2B,MAAM,CAAA;AACnE,IAAA,IAAI,CAAC,mBAAA,EAAqB;AACxB,MAAA;AAAA,IACF;AAAA,EACF;AAEA,EAAA,IAAI,sBAAA,GAAyB,KAAA;AAC7B,EAAA,MAAM,gBAA6B,CAAA,IAAA,KAAQ;AAEzC,IAAA,MAAM,QAAA,GAAW,IAAA,CAAK,QAAA,EAAS,CAAE,MAAM,IAAI,CAAA;AAC3C,IAAA,MAAM,SAAA,GAAY,IAAA,CAAK,MAAA,GAAS,iBAAA,GAAoB,UAAA;AACpD,IAAA,QAAA,CAAS,QAAQ,CAAA,IAAA,KAAQ;AACvB,MAAA,IAAI,SAAS,EAAA,EAAI;AACf,QAAA;AAAA,MACF;AAEA,MAAA,MAAA,CAAO,OAAA,CAAQ,CAAA,EAAG,SAAS,CAAA,CAAA,EAAI,IAAI,CAAA,CAAE,CAAA;AAGrC,MAAA,IACE,CAAC,sBAAA,IACD,IAAA,CAAK,SAAS,CAAA,WAAA,EAAc,qBAAqB,EAAE,CAAA,EACnD;AACA,QAAA,sBAAA,GAAyB,IAAA;AAAA,MAC3B;AAAA,IACF,CAAC,CAAA;AAAA,EACH,CAAA;AAIA,EAAA,MAAA,CAAO,KAAK,yBAAyB,CAAA;AACrC,EAAA,MAAM,qBAAqBC,4BAAA,CAAgB;AAAA,IACzC,MAAM,IAAA,CAAK,UAAA;AAAA,IACX,aAAa,IAAA,CAAK,WAAA;AAAA,IAClB,kBAAkB,IAAA,CAAK,gBAAA;AAAA,IACvB,eAAe,IAAA,CAAK,YAAA;AAAA,IACpB,WAAW,IAAA,CAAK,MAAA;AAAA,IAChB,QAAA,EAAU,aAAA;AAAA,IACV,QAAA,EAAU,aAAA;AAAA,IACV,oBAAA,EAAsB,aAAA;AAAA,IACtB,sBAAsB,IAAA,CAAK,oBAAA;AAAA,IAC3B,4BAA4B,IAAA,CAAK,0BAAA;AAAA,IACjC,uBAAuB,IAAA,CAAK;AAAA,GAC7B,CAAA;AAID,EAAA,KAAA,IAAS,OAAA,GAAU,CAAA,EAAG,OAAA,GAAU,EAAA,EAAI,OAAA,EAAA,EAAW;AAC7C,IAAA,MAAM,IAAI,OAAA,CAAQ,CAAA,CAAA,KAAK,UAAA,CAAW,CAAA,EAAG,GAAI,CAAC,CAAA;AAC1C,IAAA,IAAI,sBAAA,EAAwB;AAC1B,MAAA;AAAA,IACF;AACA,IAAA,MAAA,CAAO,KAAK,uCAAuC,CAAA;AAAA,EACrD;AAEA,EAAA,IAAI,CAAC,sBAAA,EAAwB;AAC3B,IAAA,MAAA,CAAO,KAAA;AAAA,MACL;AAAA,KACF;AAAA,EACF;AAEA,EAAA,MAAM,IAAA,GAAO,SAAA,GAAY,oBAAA,GAAuB,IAAA,CAAK,cAAA;AACrD,EAAA,MAAM,cAAA,GAAiB,kBAAkB,IAAI,CAAA;AAC7C,EAAA,MAAMC,eAAa,IAAIC,kBAAA;AAAA,IACrB,cAAA;AAAA,IACA,IAAA;AAAA,IACA,qBAAA;AAAA,IACA,IAAA,CAAK;AAAA,GACP;AAEA,EAAAD,YAAA,CACG,KAAA,EAAM,CACN,KAAA,CAAM,CAAA,GAAA,KAAO;AACZ,IAAA,MAAA,CAAO,KAAA,CAAM,+BAA+B,GAAG,CAAA;AAC/C,IAAA,kBAAA,CAAmB,IAAA,EAAK;AACxB,IAAA,OAAA,CAAQ,KAAK,CAAC,CAAA;AAAA,EAChB,CAAC,CAAA,CACA,IAAA,CAAK,MAAM;AAEV,IAAAE,4BAAA,CAAY,CAAA,iBAAA,EAAoB,IAAI,CAAA,8BAAA,CAAgC,CAAA;AACpE,IAAA,MAAA,CAAO,IAAA;AAAA,MACL,iDAAiD,IAAI,CAAA;AAAA,gBAAA;AAAA,KACvD;AAAA,EACF,CAAC,CAAA;AAEH,EAAA,MAAM,mBAAmB,WAAA,EAAY;AAErC,EAAA,IAAI,iBAAA,EAAmB;AACrB,IAAA,OAAA,CAAQ,EAAA,CAAG,QAAQ,YAAY;AAC7B,MAAAC,mBAAA,CAAG,MAAA,CAAO,aAAA,EAAe,EAAE,CAAA;AAAA,IAC7B,CAAC,CAAA;AAAA,EACH;AACF;;;;"}
|
|
1
|
+
{"version":3,"file":"serve.cjs.js","sources":["../../../src/commands/serve/serve.ts"],"sourcesContent":["/*\n * Copyright 2020 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 { OptionValues } from 'commander';\nimport path from 'node:path';\nimport openBrowser from 'react-dev-utils/openBrowser';\nimport { findPaths, RunOnOutput } from '@backstage/cli-common';\nimport HTTPServer from '../../lib/httpServer';\nimport { runMkdocsServer } from '../../lib/mkdocsServer';\nimport { createLogger } from '../../lib/utility';\nimport { getMkdocsYml } from '@backstage/plugin-techdocs-node';\nimport fs from 'fs-extra';\nimport { checkIfDockerIsOperational } from './utils';\n\nfunction findPreviewBundlePath(): string {\n try {\n return path.join(\n path.dirname(require.resolve('techdocs-cli-embedded-app/package.json')),\n 'dist',\n );\n } catch {\n // If the techdocs-cli-embedded-app package is not available it means we're\n // running a published package. For published packages the preview bundle is\n // copied to dist/embedded-app be the prepack script.\n //\n // This can be tested by running `yarn pack` and extracting the resulting tarball into a directory.\n // Within the extracted directory, run `npm install --only=prod`.\n // Once that's done you can test the CLI in any directory using `node <tmp-dir>/package <command>`.\n // eslint-disable-next-line no-restricted-syntax\n return findPaths(__dirname).resolveOwn('dist/embedded-app');\n }\n}\n\nfunction getPreviewAppPath(opts: OptionValues): string {\n return opts.previewAppBundlePath ?? findPreviewBundlePath();\n}\n\nexport default async function serve(opts: OptionValues) {\n const logger = createLogger({ verbose: opts.verbose });\n\n // Determine if we want to run in local dev mode or not\n // This will run the backstage http server on a different port and only used\n // for proxying mkdocs to the backstage app running locally (e.g. with webpack-dev-server)\n const isDevMode = Object.keys(process.env).includes('TECHDOCS_CLI_DEV_MODE')\n ? true\n : false;\n\n const backstageBackendPort = 7007;\n\n const mkdocsDockerAddr = `http://0.0.0.0:${opts.mkdocsPort}`;\n const mkdocsLocalAddr = `http://127.0.0.1:${opts.mkdocsPort}`;\n const mkdocsExpectedDevAddr = opts.docker\n ? mkdocsDockerAddr\n : mkdocsLocalAddr;\n const mkdocsConfigFileName = opts.mkdocsConfigFileName;\n const siteName = opts.siteName;\n\n const { path: mkdocsYmlPath, configIsTemporary } = await getMkdocsYml('./', {\n name: siteName,\n mkdocsConfigFileName,\n });\n\n // Validate that Docker is up and running\n if (opts.docker) {\n const isDockerOperational = await checkIfDockerIsOperational(logger);\n if (!isDockerOperational) {\n return;\n }\n }\n\n let mkdocsServerHasStarted = false;\n const mkdocsLogFunc: RunOnOutput = data => {\n // Sometimes the lines contain an unnecessary extra new line\n const logLines = data.toString().split('\\n');\n const logPrefix = opts.docker ? '[docker/mkdocs]' : '[mkdocs]';\n logLines.forEach(line => {\n if (line === '') {\n return;\n }\n\n logger.verbose(`${logPrefix} ${line}`);\n\n // When the server has started, open a new browser tab for the user.\n if (\n !mkdocsServerHasStarted &&\n line.includes(`Serving on ${mkdocsExpectedDevAddr}`)\n ) {\n mkdocsServerHasStarted = true;\n }\n });\n };\n // mkdocs writes all of its logs to stderr by default, and not stdout.\n // https://github.com/mkdocs/mkdocs/issues/879#issuecomment-203536006\n // Had me questioning this whole implementation for half an hour.\n logger.info('Starting mkdocs server.');\n const mkdocsChildProcess = runMkdocsServer({\n port: opts.mkdocsPort,\n dockerImage: opts.dockerImage,\n dockerEntrypoint: opts.dockerEntrypoint,\n dockerOptions: opts.dockerOption,\n useDocker: opts.docker,\n onStdout: mkdocsLogFunc,\n onStderr: mkdocsLogFunc,\n mkdocsConfigFileName: mkdocsYmlPath,\n mkdocsParameterClean: opts.mkdocsParameterClean,\n mkdocsParameterDirtyReload: opts.mkdocsParameterDirtyreload,\n mkdocsParameterStrict: opts.mkdocsParameterStrict,\n });\n\n // Wait until mkdocs server has started so that Backstage starts with docs loaded\n // Takes 1-5 seconds\n for (let attempt = 0; attempt < 30; attempt++) {\n await new Promise(r => setTimeout(r, 3000));\n if (mkdocsServerHasStarted) {\n break;\n }\n logger.info('Waiting for mkdocs server to start...');\n }\n\n if (!mkdocsServerHasStarted) {\n logger.error(\n 'mkdocs server did not start. Exiting. Try re-running command with -v option for more details.',\n );\n }\n\n const port = isDevMode ? backstageBackendPort : opts.previewAppPort;\n const previewAppPath = getPreviewAppPath(opts);\n const httpServer = new HTTPServer(\n previewAppPath,\n port,\n mkdocsExpectedDevAddr,\n opts.verbose,\n );\n\n httpServer\n .serve()\n .catch(err => {\n logger.error('Failed to start HTTP server', err);\n mkdocsChildProcess.kill();\n process.exit(1);\n })\n .then(() => {\n // The last three things default/component/local/ don't matter. They can be anything.\n openBrowser(`http://localhost:${port}/docs/default/component/local/`);\n logger.info(\n `Serving docs in Backstage at http://localhost:${port}/docs/default/component/local/\\nOpening browser.`,\n );\n });\n\n await mkdocsChildProcess.waitForExit();\n\n if (configIsTemporary) {\n process.on('exit', async () => {\n fs.rmSync(mkdocsYmlPath, {});\n });\n }\n}\n"],"names":["path","findPaths","createLogger","getMkdocsYml","checkIfDockerIsOperational","runMkdocsServer","httpServer","HTTPServer","openBrowser","fs"],"mappings":";;;;;;;;;;;;;;;;;;;;AA2BA,SAAS,qBAAA,GAAgC;AACvC,EAAA,IAAI;AACF,IAAA,OAAOA,qBAAA,CAAK,IAAA;AAAA,MACVA,qBAAA,CAAK,OAAA,CAAQ,OAAA,CAAQ,OAAA,CAAQ,wCAAwC,CAAC,CAAA;AAAA,MACtE;AAAA,KACF;AAAA,EACF,CAAA,CAAA,MAAQ;AASN,IAAA,OAAOC,mBAAA,CAAU,SAAS,CAAA,CAAE,UAAA,CAAW,mBAAmB,CAAA;AAAA,EAC5D;AACF;AAEA,SAAS,kBAAkB,IAAA,EAA4B;AACrD,EAAA,OAAO,IAAA,CAAK,wBAAwB,qBAAA,EAAsB;AAC5D;AAEA,eAA8B,MAAM,IAAA,EAAoB;AACtD,EAAA,MAAM,SAASC,oBAAA,CAAa,EAAE,OAAA,EAAS,IAAA,CAAK,SAAS,CAAA;AAKrD,EAAA,MAAM,SAAA,GAAY,OAAO,IAAA,CAAK,OAAA,CAAQ,GAAG,CAAA,CAAE,QAAA,CAAS,uBAAuB,CAAA,GACvE,IAAA,GACA,KAAA;AAEJ,EAAA,MAAM,oBAAA,GAAuB,IAAA;AAE7B,EAAA,MAAM,gBAAA,GAAmB,CAAA,eAAA,EAAkB,IAAA,CAAK,UAAU,CAAA,CAAA;AAC1D,EAAA,MAAM,eAAA,GAAkB,CAAA,iBAAA,EAAoB,IAAA,CAAK,UAAU,CAAA,CAAA;AAC3D,EAAA,MAAM,qBAAA,GAAwB,IAAA,CAAK,MAAA,GAC/B,gBAAA,GACA,eAAA;AACJ,EAAA,MAAM,uBAAuB,IAAA,CAAK,oBAAA;AAClC,EAAA,MAAM,WAAW,IAAA,CAAK,QAAA;AAEtB,EAAA,MAAM,EAAE,IAAA,EAAM,aAAA,EAAe,mBAAkB,GAAI,MAAMC,gCAAa,IAAA,EAAM;AAAA,IAC1E,IAAA,EAAM,QAAA;AAAA,IACN;AAAA,GACD,CAAA;AAGD,EAAA,IAAI,KAAK,MAAA,EAAQ;AACf,IAAA,MAAM,mBAAA,GAAsB,MAAMC,gCAAA,CAA2B,MAAM,CAAA;AACnE,IAAA,IAAI,CAAC,mBAAA,EAAqB;AACxB,MAAA;AAAA,IACF;AAAA,EACF;AAEA,EAAA,IAAI,sBAAA,GAAyB,KAAA;AAC7B,EAAA,MAAM,gBAA6B,CAAA,IAAA,KAAQ;AAEzC,IAAA,MAAM,QAAA,GAAW,IAAA,CAAK,QAAA,EAAS,CAAE,MAAM,IAAI,CAAA;AAC3C,IAAA,MAAM,SAAA,GAAY,IAAA,CAAK,MAAA,GAAS,iBAAA,GAAoB,UAAA;AACpD,IAAA,QAAA,CAAS,QAAQ,CAAA,IAAA,KAAQ;AACvB,MAAA,IAAI,SAAS,EAAA,EAAI;AACf,QAAA;AAAA,MACF;AAEA,MAAA,MAAA,CAAO,OAAA,CAAQ,CAAA,EAAG,SAAS,CAAA,CAAA,EAAI,IAAI,CAAA,CAAE,CAAA;AAGrC,MAAA,IACE,CAAC,sBAAA,IACD,IAAA,CAAK,SAAS,CAAA,WAAA,EAAc,qBAAqB,EAAE,CAAA,EACnD;AACA,QAAA,sBAAA,GAAyB,IAAA;AAAA,MAC3B;AAAA,IACF,CAAC,CAAA;AAAA,EACH,CAAA;AAIA,EAAA,MAAA,CAAO,KAAK,yBAAyB,CAAA;AACrC,EAAA,MAAM,qBAAqBC,4BAAA,CAAgB;AAAA,IACzC,MAAM,IAAA,CAAK,UAAA;AAAA,IACX,aAAa,IAAA,CAAK,WAAA;AAAA,IAClB,kBAAkB,IAAA,CAAK,gBAAA;AAAA,IACvB,eAAe,IAAA,CAAK,YAAA;AAAA,IACpB,WAAW,IAAA,CAAK,MAAA;AAAA,IAChB,QAAA,EAAU,aAAA;AAAA,IACV,QAAA,EAAU,aAAA;AAAA,IACV,oBAAA,EAAsB,aAAA;AAAA,IACtB,sBAAsB,IAAA,CAAK,oBAAA;AAAA,IAC3B,4BAA4B,IAAA,CAAK,0BAAA;AAAA,IACjC,uBAAuB,IAAA,CAAK;AAAA,GAC7B,CAAA;AAID,EAAA,KAAA,IAAS,OAAA,GAAU,CAAA,EAAG,OAAA,GAAU,EAAA,EAAI,OAAA,EAAA,EAAW;AAC7C,IAAA,MAAM,IAAI,OAAA,CAAQ,CAAA,CAAA,KAAK,UAAA,CAAW,CAAA,EAAG,GAAI,CAAC,CAAA;AAC1C,IAAA,IAAI,sBAAA,EAAwB;AAC1B,MAAA;AAAA,IACF;AACA,IAAA,MAAA,CAAO,KAAK,uCAAuC,CAAA;AAAA,EACrD;AAEA,EAAA,IAAI,CAAC,sBAAA,EAAwB;AAC3B,IAAA,MAAA,CAAO,KAAA;AAAA,MACL;AAAA,KACF;AAAA,EACF;AAEA,EAAA,MAAM,IAAA,GAAO,SAAA,GAAY,oBAAA,GAAuB,IAAA,CAAK,cAAA;AACrD,EAAA,MAAM,cAAA,GAAiB,kBAAkB,IAAI,CAAA;AAC7C,EAAA,MAAMC,eAAa,IAAIC,kBAAA;AAAA,IACrB,cAAA;AAAA,IACA,IAAA;AAAA,IACA,qBAAA;AAAA,IACA,IAAA,CAAK;AAAA,GACP;AAEA,EAAAD,YAAA,CACG,KAAA,EAAM,CACN,KAAA,CAAM,CAAA,GAAA,KAAO;AACZ,IAAA,MAAA,CAAO,KAAA,CAAM,+BAA+B,GAAG,CAAA;AAC/C,IAAA,kBAAA,CAAmB,IAAA,EAAK;AACxB,IAAA,OAAA,CAAQ,KAAK,CAAC,CAAA;AAAA,EAChB,CAAC,CAAA,CACA,IAAA,CAAK,MAAM;AAEV,IAAAE,4BAAA,CAAY,CAAA,iBAAA,EAAoB,IAAI,CAAA,8BAAA,CAAgC,CAAA;AACpE,IAAA,MAAA,CAAO,IAAA;AAAA,MACL,iDAAiD,IAAI,CAAA;AAAA,gBAAA;AAAA,KACvD;AAAA,EACF,CAAC,CAAA;AAEH,EAAA,MAAM,mBAAmB,WAAA,EAAY;AAErC,EAAA,IAAI,iBAAA,EAAmB;AACrB,IAAA,OAAA,CAAQ,EAAA,CAAG,QAAQ,YAAY;AAC7B,MAAAC,mBAAA,CAAG,MAAA,CAAO,aAAA,EAAe,EAAE,CAAA;AAAA,IAC7B,CAAC,CAAA;AAAA,EACH;AACF;;;;"}
|
|
@@ -1037,46 +1037,44 @@
|
|
|
1037
1037
|
"packageName": "@backstage/integration"
|
|
1038
1038
|
},
|
|
1039
1039
|
{
|
|
1040
|
-
"path": "
|
|
1040
|
+
"path": "../../plugins/catalog/config.d.ts",
|
|
1041
1041
|
"value": {
|
|
1042
1042
|
"type": "object",
|
|
1043
1043
|
"properties": {
|
|
1044
|
-
"
|
|
1044
|
+
"catalog": {
|
|
1045
1045
|
"type": "object",
|
|
1046
1046
|
"properties": {
|
|
1047
|
-
"
|
|
1048
|
-
"
|
|
1049
|
-
"
|
|
1050
|
-
|
|
1051
|
-
"
|
|
1052
|
-
"
|
|
1053
|
-
|
|
1054
|
-
|
|
1055
|
-
{
|
|
1056
|
-
"type": "object",
|
|
1057
|
-
"properties": {
|
|
1058
|
-
"include": {
|
|
1059
|
-
"type": "array",
|
|
1060
|
-
"items": {
|
|
1061
|
-
"type": "string"
|
|
1062
|
-
}
|
|
1063
|
-
},
|
|
1064
|
-
"exclude": {
|
|
1065
|
-
"type": "array",
|
|
1066
|
-
"items": {
|
|
1067
|
-
"type": "string"
|
|
1068
|
-
}
|
|
1069
|
-
}
|
|
1070
|
-
}
|
|
1071
|
-
},
|
|
1072
|
-
{
|
|
1073
|
-
"const": "all",
|
|
1074
|
-
"type": "string"
|
|
1047
|
+
"experimentalPagination": {
|
|
1048
|
+
"deepVisibility": "frontend",
|
|
1049
|
+
"anyOf": [
|
|
1050
|
+
{
|
|
1051
|
+
"type": "object",
|
|
1052
|
+
"properties": {
|
|
1053
|
+
"limit": {
|
|
1054
|
+
"type": "number"
|
|
1075
1055
|
}
|
|
1076
|
-
|
|
1056
|
+
}
|
|
1057
|
+
},
|
|
1058
|
+
{
|
|
1059
|
+
"type": "boolean"
|
|
1077
1060
|
}
|
|
1078
|
-
|
|
1079
|
-
}
|
|
1061
|
+
]
|
|
1062
|
+
}
|
|
1063
|
+
}
|
|
1064
|
+
}
|
|
1065
|
+
},
|
|
1066
|
+
"$schema": "http://json-schema.org/draft-07/schema#"
|
|
1067
|
+
},
|
|
1068
|
+
"packageName": "@backstage/plugin-catalog"
|
|
1069
|
+
},
|
|
1070
|
+
{
|
|
1071
|
+
"path": "../frontend-app-api/config.d.ts",
|
|
1072
|
+
"value": {
|
|
1073
|
+
"type": "object",
|
|
1074
|
+
"properties": {
|
|
1075
|
+
"app": {
|
|
1076
|
+
"type": "object",
|
|
1077
|
+
"properties": {
|
|
1080
1078
|
"packages": {
|
|
1081
1079
|
"description": "Controls what packages are loaded by the new frontend system.",
|
|
1082
1080
|
"visibility": "frontend",
|
|
@@ -1241,37 +1239,6 @@
|
|
|
1241
1239
|
},
|
|
1242
1240
|
"packageName": "@backstage/frontend-app-api"
|
|
1243
1241
|
},
|
|
1244
|
-
{
|
|
1245
|
-
"path": "../../plugins/catalog/config.d.ts",
|
|
1246
|
-
"value": {
|
|
1247
|
-
"type": "object",
|
|
1248
|
-
"properties": {
|
|
1249
|
-
"catalog": {
|
|
1250
|
-
"type": "object",
|
|
1251
|
-
"properties": {
|
|
1252
|
-
"experimentalPagination": {
|
|
1253
|
-
"deepVisibility": "frontend",
|
|
1254
|
-
"anyOf": [
|
|
1255
|
-
{
|
|
1256
|
-
"type": "object",
|
|
1257
|
-
"properties": {
|
|
1258
|
-
"limit": {
|
|
1259
|
-
"type": "number"
|
|
1260
|
-
}
|
|
1261
|
-
}
|
|
1262
|
-
},
|
|
1263
|
-
{
|
|
1264
|
-
"type": "boolean"
|
|
1265
|
-
}
|
|
1266
|
-
]
|
|
1267
|
-
}
|
|
1268
|
-
}
|
|
1269
|
-
}
|
|
1270
|
-
},
|
|
1271
|
-
"$schema": "http://json-schema.org/draft-07/schema#"
|
|
1272
|
-
},
|
|
1273
|
-
"packageName": "@backstage/plugin-catalog"
|
|
1274
|
-
},
|
|
1275
1242
|
{
|
|
1276
1243
|
"path": "../backend-plugin-api/config.d.ts",
|
|
1277
1244
|
"value": {
|
|
@@ -1412,6 +1379,35 @@
|
|
|
1412
1379
|
"backstageTokenExpiration": {
|
|
1413
1380
|
"description": "The backstage token expiration.\nDefaults to 1 hour (3600s). Maximum allowed is 24 hours."
|
|
1414
1381
|
},
|
|
1382
|
+
"experimentalRefreshToken": {
|
|
1383
|
+
"description": "Configuration for refresh tokens (offline access)",
|
|
1384
|
+
"visibility": "backend",
|
|
1385
|
+
"type": "object",
|
|
1386
|
+
"properties": {
|
|
1387
|
+
"enabled": {
|
|
1388
|
+
"description": "Whether to enable refresh tokens",
|
|
1389
|
+
"default": false,
|
|
1390
|
+
"visibility": "backend",
|
|
1391
|
+
"type": "boolean"
|
|
1392
|
+
},
|
|
1393
|
+
"tokenLifetime": {
|
|
1394
|
+
"description": "Token lifetime before rotation required",
|
|
1395
|
+
"default": "'30 days'",
|
|
1396
|
+
"visibility": "backend"
|
|
1397
|
+
},
|
|
1398
|
+
"maxRotationLifetime": {
|
|
1399
|
+
"description": "Maximum session lifetime across all rotations",
|
|
1400
|
+
"default": "'1 year'",
|
|
1401
|
+
"visibility": "backend"
|
|
1402
|
+
},
|
|
1403
|
+
"maxTokensPerUser": {
|
|
1404
|
+
"description": "Maximum number of refresh tokens per user",
|
|
1405
|
+
"default": 20,
|
|
1406
|
+
"visibility": "backend",
|
|
1407
|
+
"type": "number"
|
|
1408
|
+
}
|
|
1409
|
+
}
|
|
1410
|
+
},
|
|
1415
1411
|
"experimentalExtraAllowedOrigins": {
|
|
1416
1412
|
"description": "Additional app origins to allow for authenticating",
|
|
1417
1413
|
"type": "array",
|
|
@@ -1492,105 +1488,6 @@
|
|
|
1492
1488
|
},
|
|
1493
1489
|
"packageName": "@backstage/plugin-auth-backend-module-guest-provider"
|
|
1494
1490
|
},
|
|
1495
|
-
{
|
|
1496
|
-
"path": "../backend-app-api/config.d.ts",
|
|
1497
|
-
"value": {
|
|
1498
|
-
"type": "object",
|
|
1499
|
-
"properties": {
|
|
1500
|
-
"backend": {
|
|
1501
|
-
"type": "object",
|
|
1502
|
-
"properties": {
|
|
1503
|
-
"packages": {
|
|
1504
|
-
"description": "Used by the feature discovery service",
|
|
1505
|
-
"anyOf": [
|
|
1506
|
-
{
|
|
1507
|
-
"type": "object",
|
|
1508
|
-
"properties": {
|
|
1509
|
-
"include": {
|
|
1510
|
-
"type": "array",
|
|
1511
|
-
"items": {
|
|
1512
|
-
"type": "string"
|
|
1513
|
-
}
|
|
1514
|
-
},
|
|
1515
|
-
"exclude": {
|
|
1516
|
-
"type": "array",
|
|
1517
|
-
"items": {
|
|
1518
|
-
"type": "string"
|
|
1519
|
-
}
|
|
1520
|
-
}
|
|
1521
|
-
}
|
|
1522
|
-
},
|
|
1523
|
-
{
|
|
1524
|
-
"const": "all",
|
|
1525
|
-
"type": "string"
|
|
1526
|
-
}
|
|
1527
|
-
]
|
|
1528
|
-
},
|
|
1529
|
-
"startup": {
|
|
1530
|
-
"type": "object",
|
|
1531
|
-
"properties": {
|
|
1532
|
-
"default": {
|
|
1533
|
-
"type": "object",
|
|
1534
|
-
"properties": {
|
|
1535
|
-
"onPluginBootFailure": {
|
|
1536
|
-
"description": "The default value for `onPluginBootFailure` if not specified for a particular plugin.\nThis defaults to 'abort', which means `onPluginBootFailure: continue` must be specified\nfor backend startup to continue on plugin boot failure. This can also be set to\n'continue', which flips the logic for individual plugins so that they must be set to\n`onPluginBootFailure: abort` to be required.",
|
|
1537
|
-
"enum": [
|
|
1538
|
-
"abort",
|
|
1539
|
-
"continue"
|
|
1540
|
-
],
|
|
1541
|
-
"type": "string"
|
|
1542
|
-
},
|
|
1543
|
-
"onPluginModuleBootFailure": {
|
|
1544
|
-
"description": "The default value for `onPluginModuleBootFailure` if not specified for a particular plugin module.\nThis defaults to 'abort', which means `onPluginModuleBootFailure: continue` must be specified\nfor backend startup to continue on plugin module boot failure. This can also be set to\n'continue', which flips the logic for individual plugin modules so that they must be set to\n`onPluginModuleBootFailure: abort` to be required.",
|
|
1545
|
-
"enum": [
|
|
1546
|
-
"abort",
|
|
1547
|
-
"continue"
|
|
1548
|
-
],
|
|
1549
|
-
"type": "string"
|
|
1550
|
-
}
|
|
1551
|
-
}
|
|
1552
|
-
},
|
|
1553
|
-
"plugins": {
|
|
1554
|
-
"type": "object",
|
|
1555
|
-
"additionalProperties": {
|
|
1556
|
-
"type": "object",
|
|
1557
|
-
"properties": {
|
|
1558
|
-
"onPluginBootFailure": {
|
|
1559
|
-
"description": "Used to control backend startup behavior when this plugin fails to boot up. Setting\nthis to `continue` allows the backend to continue starting up, even if this plugin\nfails. This can enable leaving a crashing plugin installed, but still permit backend\nstartup, which may help troubleshoot data-dependent issues. Plugin failures for plugins\nset to `abort` are fatal (this is the default unless overridden by the `default`\nsetting).",
|
|
1560
|
-
"enum": [
|
|
1561
|
-
"abort",
|
|
1562
|
-
"continue"
|
|
1563
|
-
],
|
|
1564
|
-
"type": "string"
|
|
1565
|
-
},
|
|
1566
|
-
"modules": {
|
|
1567
|
-
"type": "object",
|
|
1568
|
-
"additionalProperties": {
|
|
1569
|
-
"type": "object",
|
|
1570
|
-
"properties": {
|
|
1571
|
-
"onPluginModuleBootFailure": {
|
|
1572
|
-
"description": "Used to control backend startup behavior when this plugin module fails to boot up. Setting\nthis to `continue` allows the backend to continue starting up, even if this plugin\nmodule fails. This can enable leaving a crashing plugin installed, but still permit backend\nstartup, which may help troubleshoot data-dependent issues. Plugin module failures for plugin modules\nset to `abort` are fatal (this is the default unless overridden by the `default`\nsetting).",
|
|
1573
|
-
"enum": [
|
|
1574
|
-
"abort",
|
|
1575
|
-
"continue"
|
|
1576
|
-
],
|
|
1577
|
-
"type": "string"
|
|
1578
|
-
}
|
|
1579
|
-
}
|
|
1580
|
-
}
|
|
1581
|
-
}
|
|
1582
|
-
}
|
|
1583
|
-
}
|
|
1584
|
-
}
|
|
1585
|
-
}
|
|
1586
|
-
}
|
|
1587
|
-
}
|
|
1588
|
-
}
|
|
1589
|
-
},
|
|
1590
|
-
"$schema": "http://json-schema.org/draft-07/schema#"
|
|
1591
|
-
},
|
|
1592
|
-
"packageName": "@backstage/backend-app-api"
|
|
1593
|
-
},
|
|
1594
1491
|
{
|
|
1595
1492
|
"path": "../backend-defaults/config.d.ts",
|
|
1596
1493
|
"value": {
|
|
@@ -2261,6 +2158,38 @@
|
|
|
2261
2158
|
"description": "Base database connection string, or object with individual connection properties",
|
|
2262
2159
|
"visibility": "secret",
|
|
2263
2160
|
"anyOf": [
|
|
2161
|
+
{
|
|
2162
|
+
"type": "object",
|
|
2163
|
+
"properties": {
|
|
2164
|
+
"type": {
|
|
2165
|
+
"description": "The specific config for Azure database for PostgreSQL connections with Entra authentication",
|
|
2166
|
+
"type": "string",
|
|
2167
|
+
"const": "azure"
|
|
2168
|
+
},
|
|
2169
|
+
"tokenCredential": {
|
|
2170
|
+
"description": "Optional Azure token credential configuration",
|
|
2171
|
+
"type": "object",
|
|
2172
|
+
"properties": {
|
|
2173
|
+
"tokenRenewableOffsetTime": {
|
|
2174
|
+
"description": "How early before an access token expires to refresh it with a new one.\nDefaults to 5 minutes\nSupported formats:\n- A string in the format of '1d', '2 seconds' etc. as supported by the `ms` library.\n- A standard ISO formatted duration string, e.g. 'P2DT6H' or 'PT1M'.\n- An object with individual units (in plural) as keys, e.g. `{ days: 2, hours: 6 }`."
|
|
2175
|
+
},
|
|
2176
|
+
"clientId": {
|
|
2177
|
+
"type": "string"
|
|
2178
|
+
},
|
|
2179
|
+
"clientSecret": {
|
|
2180
|
+
"visibility": "secret",
|
|
2181
|
+
"type": "string"
|
|
2182
|
+
},
|
|
2183
|
+
"tenantId": {
|
|
2184
|
+
"type": "string"
|
|
2185
|
+
}
|
|
2186
|
+
}
|
|
2187
|
+
}
|
|
2188
|
+
},
|
|
2189
|
+
"required": [
|
|
2190
|
+
"type"
|
|
2191
|
+
]
|
|
2192
|
+
},
|
|
2264
2193
|
{
|
|
2265
2194
|
"type": "object",
|
|
2266
2195
|
"properties": {
|
|
@@ -3254,6 +3183,105 @@
|
|
|
3254
3183
|
},
|
|
3255
3184
|
"packageName": "@backstage/plugin-events-node"
|
|
3256
3185
|
},
|
|
3186
|
+
{
|
|
3187
|
+
"path": "../backend-app-api/config.d.ts",
|
|
3188
|
+
"value": {
|
|
3189
|
+
"type": "object",
|
|
3190
|
+
"properties": {
|
|
3191
|
+
"backend": {
|
|
3192
|
+
"type": "object",
|
|
3193
|
+
"properties": {
|
|
3194
|
+
"packages": {
|
|
3195
|
+
"description": "Used by the feature discovery service",
|
|
3196
|
+
"anyOf": [
|
|
3197
|
+
{
|
|
3198
|
+
"type": "object",
|
|
3199
|
+
"properties": {
|
|
3200
|
+
"include": {
|
|
3201
|
+
"type": "array",
|
|
3202
|
+
"items": {
|
|
3203
|
+
"type": "string"
|
|
3204
|
+
}
|
|
3205
|
+
},
|
|
3206
|
+
"exclude": {
|
|
3207
|
+
"type": "array",
|
|
3208
|
+
"items": {
|
|
3209
|
+
"type": "string"
|
|
3210
|
+
}
|
|
3211
|
+
}
|
|
3212
|
+
}
|
|
3213
|
+
},
|
|
3214
|
+
{
|
|
3215
|
+
"const": "all",
|
|
3216
|
+
"type": "string"
|
|
3217
|
+
}
|
|
3218
|
+
]
|
|
3219
|
+
},
|
|
3220
|
+
"startup": {
|
|
3221
|
+
"type": "object",
|
|
3222
|
+
"properties": {
|
|
3223
|
+
"default": {
|
|
3224
|
+
"type": "object",
|
|
3225
|
+
"properties": {
|
|
3226
|
+
"onPluginBootFailure": {
|
|
3227
|
+
"description": "The default value for `onPluginBootFailure` if not specified for a particular plugin.\nThis defaults to 'abort', which means `onPluginBootFailure: continue` must be specified\nfor backend startup to continue on plugin boot failure. This can also be set to\n'continue', which flips the logic for individual plugins so that they must be set to\n`onPluginBootFailure: abort` to be required.",
|
|
3228
|
+
"enum": [
|
|
3229
|
+
"abort",
|
|
3230
|
+
"continue"
|
|
3231
|
+
],
|
|
3232
|
+
"type": "string"
|
|
3233
|
+
},
|
|
3234
|
+
"onPluginModuleBootFailure": {
|
|
3235
|
+
"description": "The default value for `onPluginModuleBootFailure` if not specified for a particular plugin module.\nThis defaults to 'abort', which means `onPluginModuleBootFailure: continue` must be specified\nfor backend startup to continue on plugin module boot failure. This can also be set to\n'continue', which flips the logic for individual plugin modules so that they must be set to\n`onPluginModuleBootFailure: abort` to be required.",
|
|
3236
|
+
"enum": [
|
|
3237
|
+
"abort",
|
|
3238
|
+
"continue"
|
|
3239
|
+
],
|
|
3240
|
+
"type": "string"
|
|
3241
|
+
}
|
|
3242
|
+
}
|
|
3243
|
+
},
|
|
3244
|
+
"plugins": {
|
|
3245
|
+
"type": "object",
|
|
3246
|
+
"additionalProperties": {
|
|
3247
|
+
"type": "object",
|
|
3248
|
+
"properties": {
|
|
3249
|
+
"onPluginBootFailure": {
|
|
3250
|
+
"description": "Used to control backend startup behavior when this plugin fails to boot up. Setting\nthis to `continue` allows the backend to continue starting up, even if this plugin\nfails. This can enable leaving a crashing plugin installed, but still permit backend\nstartup, which may help troubleshoot data-dependent issues. Plugin failures for plugins\nset to `abort` are fatal (this is the default unless overridden by the `default`\nsetting).",
|
|
3251
|
+
"enum": [
|
|
3252
|
+
"abort",
|
|
3253
|
+
"continue"
|
|
3254
|
+
],
|
|
3255
|
+
"type": "string"
|
|
3256
|
+
},
|
|
3257
|
+
"modules": {
|
|
3258
|
+
"type": "object",
|
|
3259
|
+
"additionalProperties": {
|
|
3260
|
+
"type": "object",
|
|
3261
|
+
"properties": {
|
|
3262
|
+
"onPluginModuleBootFailure": {
|
|
3263
|
+
"description": "Used to control backend startup behavior when this plugin module fails to boot up. Setting\nthis to `continue` allows the backend to continue starting up, even if this plugin\nmodule fails. This can enable leaving a crashing plugin installed, but still permit backend\nstartup, which may help troubleshoot data-dependent issues. Plugin module failures for plugin modules\nset to `abort` are fatal (this is the default unless overridden by the `default`\nsetting).",
|
|
3264
|
+
"enum": [
|
|
3265
|
+
"abort",
|
|
3266
|
+
"continue"
|
|
3267
|
+
],
|
|
3268
|
+
"type": "string"
|
|
3269
|
+
}
|
|
3270
|
+
}
|
|
3271
|
+
}
|
|
3272
|
+
}
|
|
3273
|
+
}
|
|
3274
|
+
}
|
|
3275
|
+
}
|
|
3276
|
+
}
|
|
3277
|
+
}
|
|
3278
|
+
}
|
|
3279
|
+
}
|
|
3280
|
+
},
|
|
3281
|
+
"$schema": "http://json-schema.org/draft-07/schema#"
|
|
3282
|
+
},
|
|
3283
|
+
"packageName": "@backstage/backend-app-api"
|
|
3284
|
+
},
|
|
3257
3285
|
{
|
|
3258
3286
|
"path": "../../plugins/auth-backend-module-google-provider/config.d.ts",
|
|
3259
3287
|
"value": {
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<!doctype html><html lang="en"><head><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1"/><meta name="theme-color" content="#000000"/><meta name="color-scheme" content="light dark"/><meta name="description" content="Backstage is an open source framework for building developer portals"/><link rel="manifest" href="/manifest.json" crossorigin="use-credentials"/><link rel="icon" href="/favicon.ico"/><link rel="shortcut icon" href="/favicon.ico"/><link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png"/><link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png"/><link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png"/><link rel="mask-icon" href="/safari-pinned-tab.svg" color="#5bbad5"/><title>Techdocs Preview App</title><meta name="backstage-app-mode" content="public"><script defer="defer" src="/static/runtime.
|
|
1
|
+
<!doctype html><html lang="en"><head><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1"/><meta name="theme-color" content="#000000"/><meta name="color-scheme" content="light dark"/><meta name="description" content="Backstage is an open source framework for building developer portals"/><link rel="manifest" href="/manifest.json" crossorigin="use-credentials"/><link rel="icon" href="/favicon.ico"/><link rel="shortcut icon" href="/favicon.ico"/><link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png"/><link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png"/><link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png"/><link rel="mask-icon" href="/safari-pinned-tab.svg" color="#5bbad5"/><title>Techdocs Preview App</title><meta name="backstage-app-mode" content="public"><script defer="defer" src="/static/runtime.18d1df8a.js"></script><script defer="defer" src="/static/module-material-ui.3c48b777.js"></script><script defer="defer" src="/static/module-lodash.c50623b1.js"></script><script defer="defer" src="/static/module-date-fns.bfd1b82f.js"></script><script defer="defer" src="/static/module-mui.c5efba64.js"></script><script defer="defer" src="/static/module-material-table.40a11f4e.js"></script><script defer="defer" src="/static/module-micromark-core-commonmark.909b7d4e.js"></script><script defer="defer" src="/static/module-parse5.94980036.js"></script><script defer="defer" src="/static/module-zod.c31bff05.js"></script><script defer="defer" src="/static/module-react-dom.c631e87d.js"></script><script defer="defer" src="/static/module-i18next.c154323c.js"></script><script defer="defer" src="/static/module-react-beautiful-dnd.6e061f96.js"></script><script defer="defer" src="/static/module-remix-run.d87774b0.js"></script><script defer="defer" src="/static/vendor.e4357869.js"></script><script defer="defer" src="/static/main.c9d6fc0d.js"></script><link href="/static/main.b2329633.css" rel="stylesheet"><script type="backstage.io/config">[
|
|
2
2
|
{
|
|
3
3
|
"context": "app-config.yaml",
|
|
4
4
|
"data": {
|
|
@@ -43,7 +43,7 @@
|
|
|
43
43
|
color="#5bbad5"
|
|
44
44
|
/>
|
|
45
45
|
<title><%= config.getString('app.title') %></title>
|
|
46
|
-
<meta name="backstage-app-mode" content="public"><meta name="backstage-public-path" content="<%= publicPath %>/"><script defer src="<%= publicPath %>/static/runtime.
|
|
46
|
+
<meta name="backstage-app-mode" content="public"><meta name="backstage-public-path" content="<%= publicPath %>/"><script defer src="<%= publicPath %>/static/runtime.18d1df8a.js"></script><script defer src="<%= publicPath %>/static/module-material-ui.3c48b777.js"></script><script defer src="<%= publicPath %>/static/module-lodash.c50623b1.js"></script><script defer src="<%= publicPath %>/static/module-date-fns.bfd1b82f.js"></script><script defer src="<%= publicPath %>/static/module-mui.c5efba64.js"></script><script defer src="<%= publicPath %>/static/module-material-table.40a11f4e.js"></script><script defer src="<%= publicPath %>/static/module-micromark-core-commonmark.909b7d4e.js"></script><script defer src="<%= publicPath %>/static/module-parse5.94980036.js"></script><script defer src="<%= publicPath %>/static/module-zod.c31bff05.js"></script><script defer src="<%= publicPath %>/static/module-react-dom.c631e87d.js"></script><script defer src="<%= publicPath %>/static/module-i18next.c154323c.js"></script><script defer src="<%= publicPath %>/static/module-react-beautiful-dnd.6e061f96.js"></script><script defer src="<%= publicPath %>/static/module-remix-run.d87774b0.js"></script><script defer src="<%= publicPath %>/static/vendor.e4357869.js"></script><script defer src="<%= publicPath %>/static/main.c9d6fc0d.js"></script><link href="<%= publicPath %>/static/main.b2329633.css" rel="stylesheet"></head>
|
|
47
47
|
<body>
|
|
48
48
|
<noscript>You need to enable JavaScript to run this app.</noscript>
|
|
49
49
|
<div id="root"></div>
|