Document the changes

Signed-off-by: David Roberts <David.Roberts@orbis.com>

.changeset/itchy-news-drive.md

@@ -0,0 +1,15 @@
+---
+'@backstage/plugin-azure-devops-backend': minor
+'@backstage/plugin-azure-devops-common': minor
+'@backstage/plugin-azure-devops': minor
+---
+
+Ability to fetch the README file from a different AZD path.
+
+Defaults to the current, AZD default behaviour (`README.md` in the root of the git repo); to use a different path, add the annotation `dev.azure.com/readme-path`
+
+Example:
+
+```yaml
+dev.azure.com/readme-path: /my-path/CHANGELOG.md
+```

plugins/azure-devops/README.md

@@ -63,13 +63,21 @@ spec:
 
 #### Mono repos
 
-If you have multiple entities within a single repo, you will need to specify which pipelines belong to each entity.
+If you have multiple entities within a single repo, you will need to specify which pipelines belong to each entity:
 
 ```yaml
 dev.azure.com/project-repo: <my-project>/<my-repo>
 dev.azure.com/build-definition: <build-definition-name>
 ```
 
+...and which README file belongs to each entity.
+
+Example:
+
+```yaml
+dev.azure.com/readme-path: /<path-to>/<my-readme-file>.md
+```
+
 #### Pipeline in different project to repo
 
 If your pipeline is in a different project to the source code, you will need to specify this in the project annotation.