@techdocs/cli 1.4.3-next.2 → 1.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 +12 -0
- package/dist/cjs/{migrate-0697fdb4.cjs.js → migrate-32510d4d.cjs.js} +2 -2
- package/dist/cjs/migrate-32510d4d.cjs.js.map +1 -0
- package/dist/cjs/{publish-ac098b56.cjs.js → publish-2c1fe164.cjs.js} +2 -2
- package/dist/cjs/publish-2c1fe164.cjs.js.map +1 -0
- package/dist/embedded-app/.config-schema.json +50 -0
- package/dist/embedded-app/index.html +1 -1
- package/dist/embedded-app/static/main.6328c68d.js +522 -0
- package/dist/embedded-app/static/main.6328c68d.js.map +1 -0
- package/dist/embedded-app/static/{module-octokit.fe13bd50.js → module-octokit.a126d1a6.js} +2 -2
- package/dist/embedded-app/static/{module-octokit.fe13bd50.js.map → module-octokit.a126d1a6.js.map} +1 -1
- package/dist/embedded-app/static/{runtime.f4c9013f.js → runtime.6328c68d.js} +1 -1
- package/dist/embedded-app/static/{runtime.f4c9013f.js.map → runtime.6328c68d.js.map} +1 -1
- package/dist/embedded-app/static/{vendor.f4c9013f.js → vendor.6328c68d.js} +1 -1
- package/dist/embedded-app/static/{vendor.f4c9013f.js.map → vendor.6328c68d.js.map} +1 -1
- package/dist/index.cjs.js +3 -3
- package/package.json +6 -6
- package/dist/cjs/migrate-0697fdb4.cjs.js.map +0 -1
- package/dist/cjs/publish-ac098b56.cjs.js.map +0 -1
- package/dist/embedded-app/static/main.f4c9013f.js +0 -522
- package/dist/embedded-app/static/main.f4c9013f.js.map +0 -1
package/dist/index.cjs.js
CHANGED
|
@@ -83,7 +83,7 @@ function registerCommands(program) {
|
|
|
83
83
|
"--concurrency <MAX CONCURRENT REQS>",
|
|
84
84
|
"Optional Controls the number of API requests allowed to be performed simultaneously.",
|
|
85
85
|
"25"
|
|
86
|
-
).option("-v --verbose", "Enable verbose output.", false).action(lazy(() => Promise.resolve().then(function () { return require('./cjs/migrate-
|
|
86
|
+
).option("-v --verbose", "Enable verbose output.", false).action(lazy(() => Promise.resolve().then(function () { return require('./cjs/migrate-32510d4d.cjs.js'); }).then((m) => m.default)));
|
|
87
87
|
program.command("publish").description(
|
|
88
88
|
"Publish generated TechDocs site to an external storage AWS S3, Google GCS, etc."
|
|
89
89
|
).requiredOption(
|
|
@@ -139,7 +139,7 @@ function registerCommands(program) {
|
|
|
139
139
|
"--directory <PATH>",
|
|
140
140
|
"Path of the directory containing generated files to publish",
|
|
141
141
|
"./site/"
|
|
142
|
-
).action(lazy(() => Promise.resolve().then(function () { return require('./cjs/publish-
|
|
142
|
+
).action(lazy(() => Promise.resolve().then(function () { return require('./cjs/publish-2c1fe164.cjs.js'); }).then((m) => m.default)));
|
|
143
143
|
program.command("serve:mkdocs").description("Serve a documentation project locally using MkDocs serve.").option(
|
|
144
144
|
"-i, --docker-image <DOCKER_IMAGE>",
|
|
145
145
|
"The mkdocs docker container to use",
|
|
@@ -205,7 +205,7 @@ function lazy(getActionFunc) {
|
|
|
205
205
|
};
|
|
206
206
|
}
|
|
207
207
|
|
|
208
|
-
var version = "1.4.3
|
|
208
|
+
var version = "1.4.3";
|
|
209
209
|
|
|
210
210
|
const main = (argv) => {
|
|
211
211
|
commander.program.name("techdocs-cli").version(version);
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@techdocs/cli",
|
|
3
3
|
"description": "Utility CLI for managing TechDocs sites in Backstage.",
|
|
4
|
-
"version": "1.4.3
|
|
4
|
+
"version": "1.4.3",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"access": "public"
|
|
7
7
|
},
|
|
@@ -36,7 +36,7 @@
|
|
|
36
36
|
"techdocs-cli": "bin/techdocs-cli"
|
|
37
37
|
},
|
|
38
38
|
"devDependencies": {
|
|
39
|
-
"@backstage/cli": "^0.22.8
|
|
39
|
+
"@backstage/cli": "^0.22.8",
|
|
40
40
|
"@frsource/cypress-plugin-visual-regression-diff": "^3.2.8",
|
|
41
41
|
"@types/commander": "^2.12.2",
|
|
42
42
|
"@types/fs-extra": "^9.0.6",
|
|
@@ -60,11 +60,11 @@
|
|
|
60
60
|
"ext": "ts"
|
|
61
61
|
},
|
|
62
62
|
"dependencies": {
|
|
63
|
-
"@backstage/backend-common": "^0.19.0
|
|
64
|
-
"@backstage/catalog-model": "^1.4.0
|
|
63
|
+
"@backstage/backend-common": "^0.19.0",
|
|
64
|
+
"@backstage/catalog-model": "^1.4.0",
|
|
65
65
|
"@backstage/cli-common": "^0.1.12",
|
|
66
|
-
"@backstage/config": "^1.0.
|
|
67
|
-
"@backstage/plugin-techdocs-node": "^1.7.2
|
|
66
|
+
"@backstage/config": "^1.0.8",
|
|
67
|
+
"@backstage/plugin-techdocs-node": "^1.7.2",
|
|
68
68
|
"@types/dockerode": "^3.3.0",
|
|
69
69
|
"commander": "^9.1.0",
|
|
70
70
|
"dockerode": "^3.3.1",
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"migrate-0697fdb4.cjs.js","sources":["../../src/commands/migrate/migrate.ts"],"sourcesContent":["/*\n * Copyright 2021 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 { SingleHostDiscovery } from '@backstage/backend-common';\nimport { Publisher } from '@backstage/plugin-techdocs-node';\nimport { OptionValues } from 'commander';\nimport { createLogger } from '../../lib/utility';\nimport { PublisherConfig } from '../../lib/PublisherConfig';\n\nexport default async function migrate(opts: OptionValues) {\n const logger = createLogger({ verbose: opts.verbose });\n\n const config = PublisherConfig.getValidConfig(opts);\n const discovery = SingleHostDiscovery.fromConfig(config);\n const publisher = await Publisher.fromConfig(config, { logger, discovery });\n\n if (!publisher.migrateDocsCase) {\n throw new Error(`Migration not implemented for ${opts.publisherType}`);\n }\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 throw new Error('');\n }\n\n // Validate and parse migration arguments.\n const removeOriginal = opts.removeOriginal;\n const numericConcurrency = parseInt(opts.concurrency, 10);\n\n if (!Number.isInteger(numericConcurrency) || numericConcurrency <= 0) {\n throw new Error(\n `Concurrency must be a number greater than 1. ${opts.concurrency} provided.`,\n );\n }\n\n await publisher.migrateDocsCase({\n concurrency: numericConcurrency,\n removeOriginal,\n });\n}\n"],"names":["createLogger","PublisherConfig","SingleHostDiscovery","Publisher"],"mappings":";;;;;;;;;;;AAsBA,eAA8B,QAAQ,IAAoB,EAAA;AACxD,EAAA,MAAM,SAASA,oBAAa,CAAA,EAAE,OAAS,EAAA,IAAA,CAAK,SAAS,CAAA,CAAA;AAErD,EAAM,MAAA,MAAA,GAASC,+BAAgB,CAAA,cAAA,CAAe,IAAI,CAAA,CAAA;AAClD,EAAM,MAAA,SAAA,GAAYC,iCAAoB,CAAA,UAAA,CAAW,MAAM,CAAA,CAAA;AACvD,EAAM,MAAA,SAAA,GAAY,MAAMC,4BAAU,CAAA,UAAA,CAAW,QAAQ,EAAE,MAAA,EAAQ,WAAW,CAAA,CAAA;AAE1E,EAAI,IAAA,CAAC,UAAU,eAAiB,EAAA;AAC9B,IAAA,MAAM,IAAI,KAAA,CAAM,CAAiC,8BAAA,EAAA,IAAA,CAAK,aAAe,CAAA,CAAA,CAAA,CAAA;AAAA,GACvE;AAGA,EAAA,MAAM,EAAE,WAAA,EAAgB,GAAA,MAAM,UAAU,YAAa,EAAA,CAAA;AACrD,EAAA,IAAI,CAAC,WAAa,EAAA;AAEhB,IAAM,MAAA,IAAI,MAAM,EAAE,CAAA,CAAA;AAAA,GACpB;AAGA,EAAA,MAAM,iBAAiB,IAAK,CAAA,cAAA,CAAA;AAC5B,EAAA,MAAM,kBAAqB,GAAA,QAAA,CAAS,IAAK,CAAA,WAAA,EAAa,EAAE,CAAA,CAAA;AAExD,EAAA,IAAI,CAAC,MAAO,CAAA,SAAA,CAAU,kBAAkB,CAAA,IAAK,sBAAsB,CAAG,EAAA;AACpE,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,gDAAgD,IAAK,CAAA,WAAA,CAAA,UAAA,CAAA;AAAA,KACvD,CAAA;AAAA,GACF;AAEA,EAAA,MAAM,UAAU,eAAgB,CAAA;AAAA,IAC9B,WAAa,EAAA,kBAAA;AAAA,IACb,cAAA;AAAA,GACD,CAAA,CAAA;AACH;;;;"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"publish-ac098b56.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 { SingleHostDiscovery } from '@backstage/backend-common';\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 = SingleHostDiscovery.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","SingleHostDiscovery","Publisher","resolve"],"mappings":";;;;;;;;;;;;AAwBA,eAA8B,QAAQ,IAAkC,EAAA;AACtE,EAAA,MAAM,SAASA,oBAAa,CAAA,EAAE,OAAS,EAAA,IAAA,CAAK,SAAS,CAAA,CAAA;AAErD,EAAM,MAAA,MAAA,GAASC,+BAAgB,CAAA,cAAA,CAAe,IAAI,CAAA,CAAA;AAClD,EAAM,MAAA,SAAA,GAAYC,iCAAoB,CAAA,UAAA,CAAW,MAAM,CAAA,CAAA;AACvD,EAAM,MAAA,SAAA,GAAY,MAAMC,4BAAU,CAAA,UAAA,CAAW,QAAQ,EAAE,MAAA,EAAQ,WAAW,CAAA,CAAA;AAG1E,EAAA,MAAM,EAAE,WAAA,EAAgB,GAAA,MAAM,UAAU,YAAa,EAAA,CAAA;AACrD,EAAA,IAAI,CAAC,WAAa,EAAA;AAEhB,IAAA,OAAO,OAAQ,CAAA,MAAA,CAAO,IAAI,KAAA,CAAM,EAAE,CAAC,CAAA,CAAA;AAAA,GACrC;AAEA,EAAM,MAAA,CAAC,WAAW,IAAM,EAAA,IAAI,IAAI,IAAK,CAAA,MAAA,CAAO,MAAM,GAAG,CAAA,CAAA;AACrD,EAAA,MAAM,MAAS,GAAA;AAAA,IACb,IAAA;AAAA,IACA,QAAU,EAAA;AAAA,MACR,SAAA;AAAA,MACA,IAAA;AAAA,KACF;AAAA,GACF,CAAA;AAEA,EAAM,MAAA,SAAA,GAAYC,YAAQ,CAAA,IAAA,CAAK,SAAS,CAAA,CAAA;AACxC,EAAA,MAAM,SAAU,CAAA,OAAA,CAAQ,EAAE,MAAA,EAAQ,WAAW,CAAA,CAAA;AAE7C,EAAO,OAAA,IAAA,CAAA;AACT;;;;"}
|