docs: document installation and usage of yarn plugin

Signed-off-by: MT Lewis <mtlewis@users.noreply.github.com>
2024-10-16 11:43:13 +01:00
parent d5652801eb
commit 98a1b5cf75
2 changed files with 50 additions and 2 deletions
@@ -9,5 +9,18 @@ version specified in the manifest for the Backstage release listed in
 backstage.json. If the dependent package is published, this version will be
 prefixed by `^`.

-**This plugin is still under active development, and requires some further
-testing before we recommend it for general use.**
+Detailed instructions for using the plugin can be found in [the docs](https://backstage.io/docs/getting-started/keeping-backstage-updated/#managing-package-versions-with-the-backstage-yarn-plugin).
+
+## Installation
+
+```bash
+yarn plugin import https://versions.backstage.io/v1/tags/main/yarn-plugin
+```
+
+The resulting changes in the file system should be committed to your repo.
+
+## Usage
+
+The yarn plugin recognizes the version string `"backstage:^"`, and replaces it
+with the appropriate version based on the overall Backstage version in
+backstage.json.