@backstage/plugin-catalog-backend-module-unprocessed

@backstage/plugin-catalog-backend-module-unprocessed

This catalog-backend module adds support for viewing unprocessed entities. An unprocessed entity is one that doesn't show up in the catalog.

A distinction is made between failed and pending entities.

A failed entity has validation error that breaks processing.

A pending entity has not been processed yet.

Installation

yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-unprocessed

In packages/backend/src/index.ts add the module:

backend.add(import('@backstage/plugin-catalog-backend-module-unprocessed'));

Legacy Backend

In packages/backend/src/plugins/catalog.ts import the module and initialize it after invoking CatalogBuilder.build():

import { UnprocessedEntitiesModule } from '@backstage/plugin-catalog-backend-module-unprocessed';

//...

const unprocessed = new UnprocessedEntitiesModule(
  await env.database.getClient(),
  router,
);
unprocessed.registerRoutes();