search

backstage / community-plugins

Community plugins for Backstage
Apache License 2.0
114 stars 84 forks source link

🐛 Bug Report: Azure DevOps plugin's README display doesn't cope well if you point it at a folder #186

Open DavidRobertsOrbis opened 4 months ago

DavidRobertsOrbis commented 4 months ago

📜 Description

The Azure DevOps plugin's README display doesn't cope well if you point it at a folder (rather than a markdown file, as it expects).

👍 Expected behavior

Show some pleasant error message, explaining that we need the path to a file (not the path to a folder).

Alternatively, perhaps we should look for a README.md file in the provided folder.

👎 Actual Behavior with Screenshots

Treats the folder info JSON (returned from the Azure DevOps API) as though it was markdown. image

👟 Reproduction steps

You can trigger this behaviour either with the new functionality in backstage/backstage#22791, or (easier) by creating a folder called README.md in the root of your repo. image

📃 Provide the context for the Bug.

https://github.com/backstage/backstage/pull/22791#issuecomment-1948353826

🖥️ Your Environment

OS: Linux 5.10.102.1-microsoft-standard-WSL2 - linux/x64 node: v20.10.0 yarn: 1.22.19 cli: 0.25.1 (installed) backstage: 1.22.1

Dependencies: @backstage/app-defaults 1.4.7 @backstage/backend-app-api 0.5.10 @backstage/backend-common 0.19.9, 0.20.1 @backstage/backend-dev-utils 0.1.3 @backstage/backend-openapi-utils 0.1.2 @backstage/backend-plugin-api 0.6.9 @backstage/backend-tasks 0.5.14 @backstage/catalog-client 1.5.2 @backstage/catalog-model 1.4.3 @backstage/cli-common 0.1.13 @backstage/cli-node 0.2.2 @backstage/cli 0.25.1 @backstage/config-loader 1.6.1 @backstage/config 1.1.1 @backstage/core-app-api 1.11.3 @backstage/core-compat-api 0.1.1 @backstage/core-components 0.13.10 @backstage/core-plugin-api 1.8.2 @backstage/dev-utils 1.0.26 @backstage/e2e-test-utils 0.1.0 @backstage/errors 1.2.3 @backstage/eslint-plugin 0.1.4 @backstage/frontend-plugin-api 0.5.0 @backstage/integration-aws-node 0.1.8 @backstage/integration-react 1.1.23 @backstage/integration 1.8.0 @backstage/plugin-api-docs 0.10.3 @backstage/plugin-app-backend 0.3.57 @backstage/plugin-app-node 0.1.9 @backstage/plugin-auth-backend-module-atlassian-provider 0.1.1 @backstage/plugin-auth-backend-module-gcp-iap-provider 0.2.3 @backstage/plugin-auth-backend-module-github-provider 0.1.6 @backstage/plugin-auth-backend-module-gitlab-provider 0.1.6 @backstage/plugin-auth-backend-module-google-provider 0.1.6 @backstage/plugin-auth-backend-module-oauth2-provider 0.1.6 @backstage/plugin-auth-backend-module-oauth2-proxy-provider 0.1.1 @backstage/plugin-auth-backend-module-okta-provider 0.0.2 @backstage/plugin-auth-backend 0.20.3 @backstage/plugin-auth-node 0.4.3 @backstage/plugin-azure-devops-backend 0.5.1 @backstage/plugin-azure-devops-common 0.3.2 @backstage/plugin-azure-devops 0.3.11 @backstage/plugin-catalog-backend-module-azure 0.1.28 @backstage/plugin-catalog-backend-module-msgraph 0.5.16 @backstage/plugin-catalog-backend-module-scaffolder-entity-model 0.1.6 @backstage/plugin-catalog-backend 1.16.1 @backstage/plugin-catalog-common 1.0.20 @backstage/plugin-catalog-graph 0.3.3 @backstage/plugin-catalog-import 0.10.5 @backstage/plugin-catalog-node 1.6.1 @backstage/plugin-catalog-react 1.9.3 @backstage/plugin-catalog 1.16.1 @backstage/plugin-events-node 0.2.18 @backstage/plugin-github-actions 0.6.10 @backstage/plugin-kubernetes-backend 0.14.1 @backstage/plugin-kubernetes-common 0.7.3 @backstage/plugin-kubernetes-node 0.1.3 @backstage/plugin-kubernetes-react 0.2.1 @backstage/plugin-kubernetes 0.11.4 @backstage/plugin-octopus-deploy 0.2.11 @backstage/plugin-org 0.6.19 @backstage/plugin-permission-common 0.7.12 @backstage/plugin-permission-node 0.7.20 @backstage/plugin-permission-react 0.4.19 @backstage/plugin-proxy-backend 0.4.7 @backstage/plugin-scaffolder-backend-module-azure 0.1.1 @backstage/plugin-scaffolder-backend-module-bitbucket 0.1.1 @backstage/plugin-scaffolder-backend-module-gerrit 0.1.1 @backstage/plugin-scaffolder-backend-module-github 0.1.1 @backstage/plugin-scaffolder-backend-module-gitlab 0.2.12 @backstage/plugin-scaffolder-backend 1.20.0 @backstage/plugin-scaffolder-common 1.4.5 @backstage/plugin-scaffolder-node 0.2.10 @backstage/plugin-scaffolder-react 1.7.1 @backstage/plugin-scaffolder 1.17.1 @backstage/plugin-search-backend-module-catalog 0.1.13 @backstage/plugin-search-backend-module-pg 0.5.18 @backstage/plugin-search-backend-module-techdocs 0.1.13 @backstage/plugin-search-backend-node 1.2.13 @backstage/plugin-search-backend 1.4.9 @backstage/plugin-search-common 1.2.10 @backstage/plugin-search-react 1.7.5 @backstage/plugin-search 1.4.5 @backstage/plugin-techdocs-backend 1.9.2 @backstage/plugin-techdocs-module-addons-contrib 1.1.4 @backstage/plugin-techdocs-node 1.11.1 @backstage/plugin-techdocs-react 1.1.15 @backstage/plugin-techdocs 1.9.3 @backstage/plugin-user-settings 0.8.0 @backstage/release-manifests 0.0.11 @backstage/test-utils 1.4.7 @backstage/theme 0.5.0 @backstage/types 1.1.1 @backstage/version-bridge 1.0.7

👀 Have you spent some time to check if this bug has been raised before?

🏢 Have you read the Code of Conduct?

Are you willing to submit PR?

Yes I am willing to submit a PR!

github-actions[bot] commented 2 months ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.