From ee8e016eeea3755a7955d5d06a8fc2559922a0fa Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Wed, 12 Jun 2024 19:13:40 +0200 Subject: [PATCH] docs/package-metadata: document repository field Signed-off-by: Patrik Oldsberg --- docs/tooling/package-metadata.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/tooling/package-metadata.md b/docs/tooling/package-metadata.md index 3448b10c78..673fe57edc 100644 --- a/docs/tooling/package-metadata.md +++ b/docs/tooling/package-metadata.md @@ -33,3 +33,7 @@ For plugin packages you should also pick a plugin ID and add `plugin-` For example, a frontend package for the `poetry` plugin might be called `@example/backstage-plugin-poetry`, and a backend package for the same plugin might be called `@example/backstage-plugin-poetry-backend`. If you are creating a module for an existing package that is not part of your project, you should use the same prefix along with the plugin ID of the package that the module is for. For example, if you are creating a poetry provider module for `@backstage/plugin-catalog-backend`, you might call it `@example/backstage-plugin-catalog-backend-module-poetry-provider`. + +### `repository` + +This field can be generated by the `backstage-cli repo fix --publish` command. The only requirement is that the `package.json` in your workspace root has the `repository` field documented.