Merge pull request #9306 from backstage/rugvip/eta-tea

embedded-techdocs-app -> techdocs-cli-embedded-app

.github/CODEOWNERS

@@ -34,9 +34,9 @@
 /tech-insights-backend-module-jsonfc        @backstage/reviewers @xantier @iain-b
 /tech-insights-tech-insights-common         @backstage/reviewers @xantier @iain-b
 /tech-insights-tech-insights-node           @backstage/reviewers @xantier @iain-b
-/packages/embedded-techdocs-app             @backstage/techdocs-core
 /packages/search-common                     @backstage/techdocs-core
 /packages/techdocs-cli                      @backstage/techdocs-core
+/packages/techdocs-cli-embedded-app         @backstage/techdocs-core
 /packages/techdocs-common                   @backstage/techdocs-core
 /.changeset/cost-insights-*                 @backstage/reviewers @backstage/silver-lining
 /.changeset/search-*                        @backstage/techdocs-core

packages/techdocs-cli-embedded-app/CHANGELOG.md

@@ -1,4 +1,4 @@
-# embedded-techdocs-app
+# techdocs-cli-embedded-app
 
 ## 0.2.62
 

packages/techdocs-cli-embedded-app/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "embedded-techdocs-app",
+  "name": "techdocs-cli-embedded-app",
   "version": "0.2.62",
   "private": true,
   "bundled": true,

packages/techdocs-cli/CHANGELOG.md

@@ -4,7 +4,7 @@
 
 ### Patch Changes
 
-- 14472509a3: Use a local file dependency for embedded-techdocs-app, to ensure that it's always pulled out of the workspace
+- 14472509a3: Use a local file dependency for techdocs-cli-embedded-app, to ensure that it's always pulled out of the workspace
 - Updated dependencies
   - @backstage/backend-common@0.10.6
   - @backstage/techdocs-common@0.11.6
@@ -21,7 +21,7 @@
 
 ### Patch Changes
 
-- 14472509a3: Use a local file dependency for embedded-techdocs-app, to ensure that it's always pulled out of the workspace
+- 14472509a3: Use a local file dependency for techdocs-cli-embedded-app, to ensure that it's always pulled out of the workspace
 
 ## 0.8.11
 
@@ -161,10 +161,10 @@
 
   #### :house: Internal
 
-  - `embedded-techdocs-app`
-    - [#122](https://github.com/backstage/techdocs-cli/pull/122) chore(deps-dev): bump @types/node from 12.20.20 to 16.7.1 in /packages/embedded-techdocs-app ([@dependabot[bot]](https://github.com/apps/dependabot))
-    - [#120](https://github.com/backstage/techdocs-cli/pull/120) chore(deps-dev): bump @types/react-dom from 16.9.14 to 17.0.9 in /packages/embedded-techdocs-app ([@dependabot[bot]](https://github.com/apps/dependabot))
-    - [#119](https://github.com/backstage/techdocs-cli/pull/119) chore(deps-dev): bump @testing-library/user-event from 12.8.3 to 13.2.1 in /packages/embedded-techdocs-app ([@dependabot[bot]](https://github.com/apps/dependabot))
+  - `techdocs-cli-embedded-app`
+    - [#122](https://github.com/backstage/techdocs-cli/pull/122) chore(deps-dev): bump @types/node from 12.20.20 to 16.7.1 in /packages/techdocs-cli-embedded-app ([@dependabot[bot]](https://github.com/apps/dependabot))
+    - [#120](https://github.com/backstage/techdocs-cli/pull/120) chore(deps-dev): bump @types/react-dom from 16.9.14 to 17.0.9 in /packages/techdocs-cli-embedded-app ([@dependabot[bot]](https://github.com/apps/dependabot))
+    - [#119](https://github.com/backstage/techdocs-cli/pull/119) chore(deps-dev): bump @testing-library/user-event from 12.8.3 to 13.2.1 in /packages/techdocs-cli-embedded-app ([@dependabot[bot]](https://github.com/apps/dependabot))
     - [#118](https://github.com/backstage/techdocs-cli/pull/118) chore(deps-dev): bump @testing-library/react from 10.4.9 to 12.0.0 ([@dependabot[bot]](https://github.com/apps/dependabot))
   - Other
     - [#117](https://github.com/backstage/techdocs-cli/pull/117) chore(deps): bump @backstage/plugin-catalog from 0.6.11 to 0.6.12 ([@dependabot[bot]](https://github.com/apps/dependabot))

packages/techdocs-cli/README.md

@@ -8,7 +8,7 @@ See [techdocs-cli usage docs](https://backstage.io/docs/features/techdocs/cli).
 
 ## Development
 
-NOTE: When we build `techdocs-cli` it copies the output `embedded-techdocs-app`
+NOTE: When we build `techdocs-cli` it copies the output `techdocs-cli-embedded-app`
 bundle into the `packages/techdocs-cli/dist` which is then published with the
 `@techdocs/cli` npm package.
 
@@ -16,7 +16,7 @@ bundle into the `packages/techdocs-cli/dist` which is then published with the
 
 ```sh
 # From the root of this repository run
-# NOTE: This will build the embedded-techdocs-app and copy the output into the cli dist directory
+# NOTE: This will build the techdocs-cli-embedded-app and copy the output into the cli dist directory
 yarn build --scope @techdocs/cli
 
 # Now execute the binary
@@ -26,14 +26,14 @@ packages/techdocs-cli/bin/techdocs-cli
 export PATH=/path/to/backstage/packages/techdocs-cli/bin:$PATH
 ```
 
-If you want to test live test changes to the `packages/embedded-techdocs-app`
+If you want to test live test changes to the `packages/techdocs-cli-embedded-app`
 you can serve the app and run the CLI using the following commands:
 
 ```sh
-# Open a shell to the embedded-techdocs-app directory
-cd packages/embedded-techdocs-app
+# Open a shell to the techdocs-cli-embedded-app directory
+cd packages/techdocs-cli-embedded-app
 
-# Run the embedded-techdocs-app using dev mode
+# Run the techdocs-cli-embedded-app using dev mode
 yarn start
 
 # In another shell use the techdocs-cli from the root of this repo

packages/techdocs-cli/package.json

@@ -40,7 +40,7 @@
     "@types/node": "^14.14.32",
     "@types/serve-handler": "^6.1.0",
     "@types/webpack-env": "^1.15.3",
-    "embedded-techdocs-app": "file:../embedded-techdocs-app",
+    "techdocs-cli-embedded-app": "file:../techdocs-cli-embedded-app",
     "find-process": "^1.4.5",
     "nodemon": "^2.0.2",
     "ts-node": "^10.0.0"

packages/techdocs-cli/scripts/build.sh

@@ -18,7 +18,7 @@ set -e
 
 SCRIPT_DIR=$(dirname $0)
 TECHDOCS_CLI_DIR="$SCRIPT_DIR"/..
-TECHDOCS_CLI_EMBEDDED_APP_DIR="$TECHDOCS_CLI_DIR"/../embedded-techdocs-app
+TECHDOCS_CLI_EMBEDDED_APP_DIR="$TECHDOCS_CLI_DIR"/../techdocs-cli-embedded-app
 
 compile_and_build_cli() {
   echo "📄 Compiling..."
@@ -32,9 +32,9 @@ compile_and_build_cli() {
 build_and_embed_app() {
   echo "🚚 Embedding app..."
   if [ "$TECHDOCS_CLI_DEV_MODE" = "true" ] ; then
-    yarn workspace embedded-techdocs-app build:dev > /dev/null
+    yarn workspace techdocs-cli-embedded-app build:dev > /dev/null
   else
-    yarn workspace embedded-techdocs-app build > /dev/null
+    yarn workspace techdocs-cli-embedded-app build > /dev/null
   fi
   cp -r "$TECHDOCS_CLI_EMBEDDED_APP_DIR"/dist "$TECHDOCS_CLI_DIR"/dist/techdocs-preview-bundle > /dev/null
 }

scripts/api-extractor.ts

@@ -193,7 +193,7 @@ const SKIPPED_PACKAGES = [
   join('packages', 'codemods'),
   join('packages', 'create-app'),
   join('packages', 'e2e-test'),
-  join('packages', 'embedded-techdocs-app'),
+  join('packages', 'techdocs-cli-embedded-app'),
   join('packages', 'storybook'),
   join('packages', 'techdocs-cli'),
 ];

scripts/verify-changesets.js

@@ -26,7 +26,7 @@ const privatePackages = new Set([
   'example-backend',
   'e2e-test',
   'storybook',
-  'embedded-techdocs-app',
+  'techdocs-cli-embedded-app',
 ]);
 
 async function main() {

yarn.lock

@@ -10671,7 +10671,7 @@ elliptic@^6.0.0:
     minimalistic-assert "^1.0.1"
     minimalistic-crypto-utils "^1.0.1"
 
-"embedded-techdocs-app@file:packages/embedded-techdocs-app":
+"techdocs-cli-embedded-app@file:packages/techdocs-cli-embedded-app":
   version "0.2.62"
   dependencies:
     "@backstage/app-defaults" "^0.1.6"