Skip to content

Commit

Permalink
chore(deprecation/removal): remove feedback,... (#2212)
Browse files Browse the repository at this point in the history
* regen yarnlock

Signed-off-by: Nick Boldt <nboldt@redhat.com>

chore(deprecation/removal): remove feedback, feedback-backend, and catalog-backend-module-scaffolder-relation-processor as these have moved to BCP repo

Signed-off-by: Nick Boldt <nboldt@redhat.com>

regen yarnlock

Signed-off-by: Nick Boldt <nboldt@redhat.com>

* clean up yarn lock; prettier

Signed-off-by: Nick Boldt <nboldt@redhat.com>

---------

Signed-off-by: Nick Boldt <nboldt@redhat.com>
  • Loading branch information
nickboldt authored Sep 20, 2024
1 parent 757dfef commit 5eb69f5
Show file tree
Hide file tree
Showing 109 changed files with 26 additions and 7,525 deletions.
2 changes: 1 addition & 1 deletion plugins/3scale-backend/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
},
"devDependencies": {
"@backstage/cli": "0.26.11",
"@janus-idp/cli": "1.13.1",
"@janus-idp/cli": "1.13.2",
"@types/supertest": "2.0.16",
"msw": "1.3.3",
"supertest": "6.3.4"
Expand Down
2 changes: 1 addition & 1 deletion plugins/argocd/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@
"@backstage/core-app-api": "1.14.1",
"@backstage/dev-utils": "1.0.36",
"@backstage/test-utils": "1.5.9",
"@janus-idp/cli": "1.13.1",
"@janus-idp/cli": "1.13.2",
"@playwright/test": "1.45.3",
"@redhat-developer/red-hat-developer-hub-theme": "0.2.0",
"@testing-library/jest-dom": "6.4.8",
Expand Down

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -7,74 +7,3 @@ Please use the **[@backstage-community/plugin-catalog-backend-module-scaffolder-
# Catalog Backend Module for Scaffolder Relation Catalog Processor

This is an extension module to the catalog-backend plugin, providing an additional catalog entity processor that adds a new relation that depends on the `spec.scaffoldedFrom` field to link scaffolder templates and the catalog entities they generated.

## Getting Started

1. Install the scaffolder relation catalog processor module using the following command:

```console
yarn workspace backend add @janus-idp/backstage-plugin-catalog-backend-module-scaffolder-relation-processor
```

### Installing on the new backend system

To install this module into the [new backend system](https://backstage.io/docs/backend-system/), add the following into the `packages/backend/src/index.ts` file:

```ts title="packages/backend/src/index.ts
const backend = createBackend();

// highlight-add-start
backend.add(
import(
'@janus-idp/backstage-plugin-catalog-backend-module-scaffolder-relation-processor/alpha'
),
);
// highlight-add-end

backend.start();
```

### Installing on the legacy backend system

To install this module into the legacy backend system, add the following to the `packages/backend/src/plugins/catalog.ts` file:

```ts title=packages/backend/src/plugins/catalog.ts
// highlight-add-start
import { ScaffolderRelationEntityProcessor } from '@janus-idp/backstage-plugin-catalog-backend-module-scaffolder-relation-processor';

// highlight-add-end

export default async function createPlugin(
env: PluginEnvironment,
): Promise<Router> {
const builder = await CatalogBuilder.create(env);

/* ... other processors and/or providers ... */
// highlight-add-start
builder.addProcessor(new ScaffolderRelationEntityProcessor());
// highlight-add-end

const { processingEngine, router } = await builder.build();
await processingEngine.start();

return router;
}
```

### Usage

Catalog entities containing the `spec.scaffoldedFrom` field will have a relation link be formed between it and the `template` corresponding to the entity ref in the `spec.scaffoldedFrom` field.

This link can be viewed in the `relations` field of the Raw YAML view of a catalog entity when inspecting an entity. In the entity with the `spec.scaffoldedFrom` field, the relation type is `scaffoldedFrom` with a target pointing to the value of the `spec.scaffoldedFrom` field. Conversely, for the target template, it will have a relation type of `ScaffolderOf` with a target pointing to the entity with the `spec.scaffoldedFrom` field.

These relations should also appear on the `EntityCatalogGraphView` component from the `@backstage/plugin-catalog-graph` package (only if the entity corresponding to the entity ref exists in the catalog).

#### Example graph view

![scaffoldedFrom Relation Graph View](./docs/example-images/scaffoldedFromGraphView.png)
![scaffolderOf Relation Graph View](./docs/example-images/scaffolderOfGraphView.png)

#### Example Raw YAML view

![scaffoldedFrom Relation YAML View](./docs/example-images/scaffoldedFromYAMLView.png)
![scaffoldedOf Relation YAML View](./docs/example-images/scaffolderOfYAMLView.png)
Empty file.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading

0 comments on commit 5eb69f5

Please sign in to comment.