Merge pull request #28383 from backstage/yarn-plugin-development-docs

yarn-plugin: document local development of yarn plugin
2025-01-07 10:57:37 +01:00
parent 1452040fb6 d1fd317e32
commit ec1b68334d
1 changed files with 14 additions and 0 deletions
@@ -24,3 +24,17 @@ The resulting changes in the file system should be committed to your repo.
 The yarn plugin recognizes the version string `"backstage:^"`, and replaces it
 with the appropriate version based on the overall Backstage version in
 backstage.json.
+
+## Local Development
+
+- Run unit tests: `yarn test`
+- Build the plugin locally: `yarn build`
+- Rebuild whenever plugin files change: `yarn start`
+- Install local build (in a package directory outside the Backstage monorepo):
+  `yarn plugin import
+/path/to/backstage-repo/packages/yarn-plugin/bundles/@yarnpkg/plugin-backstage.js`
+
+The plugin can be manually tested in any repository running at least yarn 4.1.1.
+Sadly it can't be manually tested directly in the Backstage monorepo - since
+packages in this repository use `workspace:^` dependencies, there's no use case
+for the yarn plugin.