catalog-backend-module-annotate-scm-slug: add option for configuring applicable entity kinds#9445
Open
04kash wants to merge 2 commits into
Open
Conversation
…applicable entity kinds Signed-off-by: Kashish Mittal <kmittal@redhat.com>
Contributor
Changed Packages
|
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a configuration surface to the @backstage-community/plugin-catalog-backend-module-annotate-scm-slug backend module so adopters can control which entity kinds the AnnotateScmSlugEntityProcessor applies to via app-config.yaml, matching the processor’s existing support for multiple kinds (per issue #9397).
Changes:
- Read
catalog.processors.annotateScmSlug.kindsfrom config and pass it intoAnnotateScmSlugEntityProcessor.fromConfig(...). - Add config reader + unit tests for the new config option.
- Document the new configuration and publish a
config.d.tsschema for Backstage config validation.
Reviewed changes
Copilot reviewed 6 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| workspaces/catalog/plugins/catalog-backend-module-annotate-scm-slug/src/module.ts | Wires configured kinds into the processor at module init time. |
| workspaces/catalog/plugins/catalog-backend-module-annotate-scm-slug/src/config.ts | Adds a small helper to read annotateScmSlug.kinds from app-config.yaml. |
| workspaces/catalog/plugins/catalog-backend-module-annotate-scm-slug/src/config.test.ts | Tests config parsing for presence/absence of kinds. |
| workspaces/catalog/plugins/catalog-backend-module-annotate-scm-slug/README.md | Documents how to configure applicable entity kinds. |
| workspaces/catalog/plugins/catalog-backend-module-annotate-scm-slug/package.json | Publishes config schema metadata and includes config.d.ts in package files. |
| workspaces/catalog/plugins/catalog-backend-module-annotate-scm-slug/config.d.ts | Defines the Backstage config schema for catalog.processors.annotateScmSlug.kinds. |
| workspaces/catalog/.changeset/wet-geese-tease.md | Declares a patch release for the new configuration option. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: Kashish Mittal <kmittal@redhat.com>
04kash
force-pushed
the
catalog-backend-module-annotate-scm-slug/configure-kinds
branch
from
a62bb8b to
a0e2c19
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Hey, I just made a Pull Request!
catalog-backend-module-annotate-scm-slugalready supports multiple kinds, this PR allows applicable kinds to be set throughapp-config.yaml.Fixes: #9397
✔️ Checklist
Signed-off-byline in the message. (more info)