From cb1cfc018b9297c0ebdc31d3c8fde7794e70a674 Mon Sep 17 00:00:00 2001 From: Alisson Fabiano Date: Mon, 22 Aug 2022 10:38:22 +0100 Subject: [PATCH] fix: update changeset docs Signed-off-by: Alisson Fabiano --- .changeset/shiny-lobsters-fix.md | 39 ++++++++++++++++++++++++++++++++ .changeset/weak-yaks-learn.md | 29 +----------------------- plugins/azure-devops/README.md | 2 +- 3 files changed, 41 insertions(+), 29 deletions(-) create mode 100644 .changeset/shiny-lobsters-fix.md diff --git a/.changeset/shiny-lobsters-fix.md b/.changeset/shiny-lobsters-fix.md new file mode 100644 index 0000000000..99e255acbe --- /dev/null +++ b/.changeset/shiny-lobsters-fix.md @@ -0,0 +1,39 @@ +--- +'@backstage/plugin-azure-devops-backend': patch +--- + +`createRouter` now requires an additional reader: `UrlReader` argument + +```diff +export default async function createPlugin( + env: PluginEnvironment, +): Promise { + return createRouter({ + logger: env.logger, + config: env.config, ++ reader: env.reader, + }); +} +``` + +Remember to check if you have already provided these settings previously. + +#### [Azure DevOps] + +```yaml +# app-config.yaml +azureDevOps: + host: dev.azure.com + token: my-token + organization: my-company +``` + +#### [Azure Integrations] + +```yaml +# app-config.yaml +integrations: + azure: + - host: dev.azure.com + token: ${AZURE_TOKEN} +``` diff --git a/.changeset/weak-yaks-learn.md b/.changeset/weak-yaks-learn.md index aa45c79524..7a94e10d68 100644 --- a/.changeset/weak-yaks-learn.md +++ b/.changeset/weak-yaks-learn.md @@ -1,36 +1,9 @@ --- '@backstage/plugin-azure-devops': minor -'@backstage/plugin-azure-devops-backend': minor '@backstage/plugin-azure-devops-common': minor --- -Added README card for Azure Devops - -**Before:** - -Remember to check if you have already provided these settings previously, as we will need them for the reamde card to work. - -#### [Azure DevOps](https://github.com/backstage/backstage/blob/master/app-config.yaml#L48L51:~:text=azureDevOps%3A,%3A%20my%2Dcompany) - -```yaml -# app-config.yaml -azureDevOps: - host: dev.azure.com - token: my-token - organization: my-company -``` - -#### [Azure Integrations](https://github.com/backstage/backstage/blob/master/app-config.yaml#L48L51:~:text=azure%3A,%3A%20%24%7BAZURE_TOKEN%7D) - -```yaml -# app-config.yaml -integrations: - azure: - - host: dev.azure.com - token: ${AZURE_TOKEN} -``` - -**After:** +Added README card `EntityAzureReadmeCard` for Azure Devops. To get the README component working you'll need to do the following two steps: diff --git a/plugins/azure-devops/README.md b/plugins/azure-devops/README.md index 47835268b3..5079fa4f16 100644 --- a/plugins/azure-devops/README.md +++ b/plugins/azure-devops/README.md @@ -76,7 +76,7 @@ In this case `` will be the name of your Team Project and `