Version Packages

plugins/techdocs-backend/CHANGELOG.md

@@ -1,5 +1,101 @@
 # @backstage/plugin-techdocs-backend
 
+## 0.9.0
+
+### Minor Changes
+
+- d32d01e5b: Improve the annotation `backstage.io/techdocs-ref: dir:<relative-target>` that links to a path that is relative to the source of the annotated entity.
+  This annotation works with the basic and the recommended flow, however, it will be most useful with the basic approach.
+
+  This change remove the deprecation of the `dir` reference and provides first-class support for it.
+  In addition, this change removes the support of the deprecated `github`, `gitlab`, and `azure/api` locations from the `dir` reference preparer.
+
+  #### Example Usage
+
+  The annotation is convenient if the documentation is stored in the same location, i.e. the same git repository, as the `catalog-info.yaml`.
+  While it is still supported to add full URLs such as `backstage.io/techdocs-ref: url:https://...` for custom setups, documentation is mostly stored in the same repository as the entity definition.
+  By automatically resolving the target relative to the registration location of the entity, the configuration overhead for this default setup is minimized.
+  Since it leverages the `@backstage/integrations` package for the URL resolution, this is compatible with every supported source.
+
+  Consider the following examples:
+
+  1. "I have a repository with a single `catalog-info.yaml` and a TechDocs page in the root folder!"
+
+  ```
+  https://github.com/backstage/example/tree/main/
+   |- catalog-info.yaml
+   |  > apiVersion: backstage.io/v1alpha1
+   |  > kind: Component
+   |  > metadata:
+   |  >   name: example
+   |  >   annotations:
+   |  >     backstage.io/techdocs-ref: dir:. # -> same folder
+   |  > spec: {}
+   |- docs/
+   |- mkdocs.yml
+  ```
+
+  2. "I have a repository with a single `catalog-info.yaml` and my TechDocs page in located in a folder!"
+
+  ```
+  https://bitbucket.org/my-owner/my-project/src/master/
+   |- catalog-info.yaml
+   |  > apiVersion: backstage.io/v1alpha1
+   |  > kind: Component
+   |  > metadata:
+   |  >   name: example
+   |  >   annotations:
+   |  >     backstage.io/techdocs-ref: dir:./some-folder # -> subfolder
+   |  > spec: {}
+   |- some-folder/
+     |- docs/
+     |- mkdocs.yml
+  ```
+
+  3. "I have a mono repository that hosts multiple components!"
+
+  ```
+  https://dev.azure.com/organization/project/_git/repository
+   |- my-1st-module/
+     |- catalog-info.yaml
+     |  > apiVersion: backstage.io/v1alpha1
+     |  > kind: Component
+     |  > metadata:
+     |  >   name: my-1st-module
+     |  >   annotations:
+     |  >     backstage.io/techdocs-ref: dir:. # -> same folder
+     |  > spec: {}
+     |- docs/
+     |- mkdocs.yml
+   |- my-2nd-module/
+     |- catalog-info.yaml
+     |  > apiVersion: backstage.io/v1alpha1
+     |  > kind: Component
+     |  > metadata:
+     |  >   name: my-2nd-module
+     |  >   annotations:
+     |  >     backstage.io/techdocs-ref: dir:. # -> same folder
+     |  > spec: {}
+     |- docs/
+     |- mkdocs.yml
+   |- catalog-info.yaml
+   |  > apiVersion: backstage.io/v1alpha1
+   |  > kind: Location
+   |  > metadata:
+   |  >   name: example
+   |  > spec:
+   |  >   targets:
+   |  >     - ./*/catalog-info.yaml
+  ```
+
+### Patch Changes
+
+- 9266b80ab: Implements tech docs collator to retrieve and expose search indexes for entities that have tech docs configured
+- Updated dependencies
+  - @backstage/techdocs-common@0.7.0
+  - @backstage/catalog-client@0.3.17
+  - @backstage/backend-common@0.8.7
+
 ## 0.8.7
 
 ### Patch Changes

plugins/techdocs-backend/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-techdocs-backend",
-  "version": "0.8.7",
+  "version": "0.9.0",
   "main": "src/index.ts",
   "types": "src/index.ts",
   "license": "Apache-2.0",
@@ -30,14 +30,14 @@
     "clean": "backstage-cli clean"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.8.6",
-    "@backstage/catalog-client": "^0.3.16",
+    "@backstage/backend-common": "^0.8.7",
+    "@backstage/catalog-client": "^0.3.17",
     "@backstage/catalog-model": "^0.9.0",
     "@backstage/config": "^0.1.5",
     "@backstage/errors": "^0.1.1",
     "@backstage/integration": "^0.5.8",
     "@backstage/search-common": "^0.1.2",
-    "@backstage/techdocs-common": "^0.6.8",
+    "@backstage/techdocs-common": "^0.7.0",
     "@types/express": "^4.17.6",
     "cross-fetch": "^3.0.6",
     "dockerode": "^3.2.1",
@@ -50,8 +50,8 @@
     "winston": "^3.2.1"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.7.4",
-    "@backstage/test-utils": "^0.1.14",
+    "@backstage/cli": "^0.7.5",
+    "@backstage/test-utils": "^0.1.15",
     "@types/dockerode": "^3.2.1",
     "msw": "^0.29.0",
     "supertest": "^6.1.3"