Reflect breaking change in changeset.

Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-09-30 13:16:08 +02:00
parent dcd3e1d968
commit 5a4597e539
1 changed files with 10 additions and 1 deletions
@@ -1,5 +1,14 @@
 ---
-'@backstage/plugin-techdocs': patch
+'@backstage/plugin-techdocs': minor
 ---

 Adds support for being able to customize and compose your TechDocs reader page in the App.
+
+You can likely upgrade to this version without issue. If, however, you have
+imported the `<Reader />` component in your custom code, the name of a property
+has changed. You will need to make the following change anywhere you use it:
+
+```diff
+-<Reader entityId={value} />
+<Reader entityRef={value} />
+```