From 52fddad92d30c000f0b45ee8bbb21be6681185bb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Anders=20N=C3=A4sman?= Date: Mon, 25 Apr 2022 16:29:35 +0200 Subject: [PATCH] changesets and fixes MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Eric Peterson Signed-off-by: Anders Näsman --- .changeset/techdocs-five-hundred-ml.md | 5 +++++ .changeset/techdocs-low-calorie-drink.md | 6 ++++++ .changeset/techdocs-vitamin-well-reload.md | 5 +++++ plugins/techdocs-addons-test-utils/README.md | 12 +----------- plugins/techdocs-module-addons-contrib/package.json | 2 +- 5 files changed, 18 insertions(+), 12 deletions(-) create mode 100644 .changeset/techdocs-five-hundred-ml.md create mode 100644 .changeset/techdocs-low-calorie-drink.md create mode 100644 .changeset/techdocs-vitamin-well-reload.md diff --git a/.changeset/techdocs-five-hundred-ml.md b/.changeset/techdocs-five-hundred-ml.md new file mode 100644 index 0000000000..775a5c55ab --- /dev/null +++ b/.changeset/techdocs-five-hundred-ml.md @@ -0,0 +1,5 @@ +--- +'@techdocs/cli': patch +--- + +The TechDocs CLI's embedded app now imports all API refs from the `@backstage/plugin-techdocs-react` package. diff --git a/.changeset/techdocs-low-calorie-drink.md b/.changeset/techdocs-low-calorie-drink.md new file mode 100644 index 0000000000..6290085d91 --- /dev/null +++ b/.changeset/techdocs-low-calorie-drink.md @@ -0,0 +1,6 @@ +--- +'@backstage/plugin-techdocs-react': patch +'@backstage/plugin-techdocs': patch +--- + +The `TechDocsStorageApi` and its associated ref are now exported by `@backstage/plugin-techdocs-react`. The API interface, ref, and types are now deprecated in `@backstage/plugin-techdocs` and will be removed in a future release. diff --git a/.changeset/techdocs-vitamin-well-reload.md b/.changeset/techdocs-vitamin-well-reload.md new file mode 100644 index 0000000000..967cc6b6a6 --- /dev/null +++ b/.changeset/techdocs-vitamin-well-reload.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-techdocs-addons-test-utils': minor +--- + +Introducing a package with utilities to help test TechDocs Addons. diff --git a/plugins/techdocs-addons-test-utils/README.md b/plugins/techdocs-addons-test-utils/README.md index fbae6b381a..a6ac2e3182 100644 --- a/plugins/techdocs-addons-test-utils/README.md +++ b/plugins/techdocs-addons-test-utils/README.md @@ -1,13 +1,3 @@ # techdocs-addons-test-utils -Welcome to the techdocs-addons-test-utils plugin! - -_This plugin was created through the Backstage CLI_ - -## Getting started - -Your plugin has been added to the example app in this repository, meaning you'll be able to access it by running `yarn start` in the root directory, and then navigating to [/techdocs-addons-test-utils](http://localhost:3000/techdocs-addons-test-utils). - -You can also serve the plugin in isolation by running `yarn start` in the plugin directory. -This method of serving the plugin provides quicker iteration speed and a faster startup and hot reloads. -It is only meant for local development, and the setup for it can be found inside the [/dev](./dev) directory. +A package containing utilities for testing TechDocs Addons. diff --git a/plugins/techdocs-module-addons-contrib/package.json b/plugins/techdocs-module-addons-contrib/package.json index 35b6df715b..090f2a24b0 100644 --- a/plugins/techdocs-module-addons-contrib/package.json +++ b/plugins/techdocs-module-addons-contrib/package.json @@ -38,7 +38,6 @@ "@backstage/core-plugin-api": "^1.0.1", "@backstage/integration": "^1.2.0-next.0", "@backstage/integration-react": "^1.1.0-next.0", - "@backstage/plugin-techdocs-addons-test-utils": "^0.0.0", "@backstage/plugin-techdocs-react": "^0.1.1-next.0", "@backstage/theme": "^0.2.15", "@material-ui/core": "^4.9.13", @@ -54,6 +53,7 @@ "@backstage/cli": "^0.17.1-next.0", "@backstage/core-app-api": "^1.0.1", "@backstage/dev-utils": "^1.0.2-next.0", + "@backstage/plugin-techdocs-addons-test-utils": "^0.0.0", "@backstage/test-utils": "^1.0.2-next.0", "@testing-library/jest-dom": "^5.10.1", "@testing-library/react": "^12.1.3",