catalog-backend-module-annotate-scm-slug: add option for configuring applicable entity kinds (#9445)

* catalog-backend-module-annotate-scm-slug: add option for configuring applicable entity kinds

Signed-off-by: Kashish Mittal <kmittal@redhat.com>

* add changeset

Signed-off-by: Kashish Mittal <kmittal@redhat.com>

* update changeset

Signed-off-by: Kashish Mittal <kmittal@redhat.com>

---------

Signed-off-by: Kashish Mittal <kmittal@redhat.com>

Author: 04kash

workspaces/catalog/.changeset/wet-geese-tease.md

@@ -0,0 +1,16 @@
+---
+'@backstage-community/plugin-catalog-backend-module-annotate-scm-slug': patch
+---
+
+add an option for configuring applicable entity kinds through app-config.yaml:
+
+```yaml
+catalog:
+  processors:
+    annotateScmSlug:
+      kinds:
+        - API
+        - Component
+        - Resource
+        - System
+```

workspaces/catalog/plugins/catalog-backend-module-annotate-scm-slug/README.md

@@ -31,6 +31,21 @@ Here's how to get the module up and running:
 
 Once catalog process has ran you should see the SCM slug added as an annotation on your entities.
 
+## Configuration
+
+By default, the processor only annotates `Component` entities. You can configure which entity kinds are processed in `app-config.yaml`:
+
+```yaml
+catalog:
+  processors:
+    annotateScmSlug:
+      kinds:
+        - API
+        - Component
+        - Resource
+        - System
+```
+
 ## Slugs Added
 
 These are the current SCM tools and their related annotation and value that are being added by this processor.

workspaces/catalog/plugins/catalog-backend-module-annotate-scm-slug/config.d.ts

@@ -0,0 +1,32 @@
+/*
+ * Copyright 2026 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export interface Config {
+  catalog?: {
+    processors?: {
+      /**
+       * Configuration for the annotate-scm-slug catalog processor.
+       */
+      annotateScmSlug?: {
+        /**
+         * Entity kinds that the processor should annotate with SCM slug metadata.
+         * Defaults to ['Component'] when not specified.
+         */
+        kinds?: string[];
+      };
+    };
+  };
+}

workspaces/catalog/plugins/catalog-backend-module-annotate-scm-slug/package.json

@@ -45,6 +45,8 @@
     "@types/lodash": "^4.17.13"
   },
   "files": [
-    "dist"
-  ]
+    "dist",
+    "config.d.ts"
+  ],
+  "configSchema": "config.d.ts"
 }

workspaces/catalog/plugins/catalog-backend-module-annotate-scm-slug/src/config.test.ts

@@ -0,0 +1,42 @@
+/*
+ * Copyright 2026 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { ConfigReader } from '@backstage/config';
+import { readAnnotateScmSlugProcessorConfig } from './config';
+
+describe('readAnnotateScmSlugProcessorConfig', () => {
+  it('returns undefined kinds when config is not set', () => {
+    expect(readAnnotateScmSlugProcessorConfig(new ConfigReader({}))).toEqual({
+      kinds: undefined,
+    });
+  });
+
+  it('reads kinds from config', () => {
+    const config = new ConfigReader({
+      catalog: {
+        processors: {
+          annotateScmSlug: {
+            kinds: ['API', 'Component', 'Resource', 'System'],
+          },
+        },
+      },
+    });
+
+    expect(readAnnotateScmSlugProcessorConfig(config)).toEqual({
+      kinds: ['API', 'Component', 'Resource', 'System'],
+    });
+  });
+});

workspaces/catalog/plugins/catalog-backend-module-annotate-scm-slug/src/config.ts

@@ -0,0 +1,28 @@
+/*
+ * Copyright 2026 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type { Config } from '@backstage/config';
+
+/** @internal */
+export function readAnnotateScmSlugProcessorConfig(config: Config): {
+  kinds?: string[];
+} {
+  return {
+    kinds: config.getOptionalStringArray(
+      'catalog.processors.annotateScmSlug.kinds',
+    ),
+  };
+}

workspaces/catalog/plugins/catalog-backend-module-annotate-scm-slug/src/module.ts

@@ -18,6 +18,7 @@ import {
   createBackendModule,
 } from '@backstage/backend-plugin-api';
 import { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node';
+import { readAnnotateScmSlugProcessorConfig } from './config';
 import { AnnotateScmSlugEntityProcessor } from './processor/AnnotateScmSlugEntityProcessor';
 
 /** @public */
@@ -31,7 +32,10 @@ export const catalogModuleAnnotateScmSlug = createBackendModule({
         catalog: catalogProcessingExtensionPoint,
       },
       async init({ catalog, config }) {
-        catalog.addProcessor(AnnotateScmSlugEntityProcessor.fromConfig(config));
+        const processorConfig = readAnnotateScmSlugProcessorConfig(config);
+        catalog.addProcessor(
+          AnnotateScmSlugEntityProcessor.fromConfig(config, processorConfig),
+        );
       },
     });
   },