Version Packages (next)

plugins/azure-devops-common/CHANGELOG.md

@@ -1,5 +1,58 @@
 # @backstage/plugin-azure-devops-common
 
+## 0.3.0-next.0
+
+### Minor Changes
+
+- 6c1c59b96e: Added README card `EntityAzureReadmeCard` for Azure Devops.
+
+  To get the README component working you'll need to do the following two steps:
+
+  1. First we need to add the @backstage/plugin-azure-devops package to your frontend app:
+
+     ```bash
+     # From your Backstage root directory
+     yarn add --cwd packages/app @backstage/plugin-azure-devops
+     ```
+
+  2. Second we need to add the `EntityAzureReadmeCard` extension to the entity page in your app:
+
+     ```tsx
+     // In packages/app/src/components/catalog/EntityPage.tsx
+     import {
+       EntityAzureReadmeCard,
+       isAzureDevOpsAvailable,
+     } from '@backstage/plugin-azure-devops';
+
+     // As it is a card, you can customize it the way you prefer
+     // For example in the Service section
+
+     const overviewContent = (
+       <Grid container spacing={3} alignItems="stretch">
+         <EntitySwitch>
+           <EntitySwitch.Case if={isAzureDevOpsAvailable}>
+             <Grid item md={6}>
+               ...
+             </Grid>
+             <Grid item md={6}>
+               <EntityAzureReadmeCard maxHeight={350} />
+             </Grid>
+           </EntitySwitch.Case>
+         </EntitySwitch>
+       </Grid>
+     );
+     ```
+
+  **Notes:**
+
+  - You'll need to add the `EntitySwitch.Case` above from step 2 to all the entity sections you want to see Readme in. For example if you wanted to see Readme when looking at Website entities then you would need to add this to the `websiteEntityPage` section.
+  - The `if` prop is optional on the `EntitySwitch.Case`, you can remove it if you always want to see the tab even if the entity being viewed does not have the needed annotation
+  - The `maxHeight` property on the `EntityAzureReadmeCard` will set the maximum screen size you would like to see, if not set it will default to 100%
+
+### Patch Changes
+
+- 3f739be9d9: Minor API signatures cleanup
+
 ## 0.2.4
 
 ### Patch Changes

plugins/azure-devops-common/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-azure-devops-common",
-  "version": "0.2.4",
+  "version": "0.3.0-next.0",
   "main": "src/index.ts",
   "types": "src/index.ts",
   "license": "Apache-2.0",
@@ -32,7 +32,7 @@
     "clean": "backstage-cli package clean"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.18.1-next.0"
+    "@backstage/cli": "^0.18.2-next.0"
   },
   "files": [
     "dist"