Skip to content

Commit 866e57b

Browse files
authored
Update readme.md
1 parent 5560fb7 commit 866e57b

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

readme.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,12 @@ It looks like this after it has run:
3030

3131
<img width="1451" alt="Screenshot 2021-12-19 at 12 55 39" src="https://user-images.githubusercontent.com/239305/146673989-01187d53-d2fd-42ba-9968-31442b8cc92d.png">
3232

33+
## Service Descriptor Format
34+
35+
This action expects each of your repositories to have a descriptor file format in the root of the repo in the form of a Backstage `catalog-info` file. This is because we are testing this approach against using Backstage directly, and wanted to leverage a format that perhaps has a chance of becoming a defacto standard. It does not currently map all fields from Backstage, but if you look at the code you can see what it does map. I may add a config option to allow mapping to be more dynamic in future (a good PR!).
36+
37+
Information on the format: https://backstage.io/docs/features/software-catalog/descriptor-format
38+
3339
## Usage
3440

3541
This is typically deployed as a scheduled action:

0 commit comments

Comments
 (0)