feat: add custom processor module to add ScaffoldedFrom relation

[Zaperex]

Description

Adds a custom catalog processor that creates relations between catalog entities and the scaffolder templates that created them based on the spec.scaffoldedFrom field in the catalog-info.yaml of the catalog entities.

What issue(s) does this fix?

Fixes: RHIDP-2156

How to test changes / Special notes to the reviewer

1. Install the module using the instructions in the README.md
2. Ingest an entity with a spec.scaffoldedFrom field that matches the entityRef of a template entity in the catalog (ex: template:default/test-template). You can potentially use the following example template: https://github.com/janus-idp/backstage-plugins/blob/main/plugins/scaffolder-annotator-action/examples/templates/01-scaffolder-template.yaml
3. Observe the relation graph of the entity in the catalog (or view the raw YAML/JSON of the entity and find the scaffoldedFrom relation in the relations array)

[Zaperex]

/retest failing

[openshift-ci[bot]]

@Zaperex: No presubmit jobs available for janus-idp/backstage-plugins@main

In response to this:

/retest failing

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[Zaperex]

/retest

[Zaperex]

/retest

[Zaperex]

Used in conjunction with https://github.com/janus-idp/backstage-plugins/pull/1567

[Zaperex]

/retest

[Zaperex]

Hmm that's weird, the template should have the reverse relation (scaffolderOf) in the dependency graph since it should appear in the relations field of it's Raw YAML. In the following, I tested with backstage-showcase when I dynamically installed it (after modifying the catalog such that the templates has a dependency graph). In my case, the ownedBy link did not appear in the dependency graph since the corresponding entity did not exist in the catalog. Could that have been the case for you?

[Zaperex]

Added usage docs with examples of expected outputs. You can try using this software template that contains the custom action that automatically applies this spec.scaffoldedFrom field to catalog entities: https://github.com/janus-idp/backstage-plugins/blob/main/plugins/scaffolder-annotator-action/examples/templates/01-scaffolder-template.yaml

[sonarqubecloud[bot]]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

[openshift-ci[bot]]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: PatAKnight

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• ~~OWNERS~~ [PatAKnight]

Approvers can indicate their approval by writing /approve in a comment Approvers can cancel approval by writing /approve cancel in a comment

[Zaperex]

It should work if you manually add it though (as long as the referenced template exists)? That's how I initially tested it before having the action.