Backstage: [Plugin] Component Scoring Plugin

[Fox32]

Summary

While the features of Backstage itself might be a good way to make teams to register their components to Backstage, it might no be sufficient. One idea would be a linting / scoring / gamification plugin that has specific rules and give a score to a component. To make it more visible, an aggregated team score would be useful.

Inspiration could be the "Pub Points" from the package manager Pub. But compared to Pub, not the implementation, but the entity description in Backstage is scored.

Example Condition:

• Component has an owner
• Component has a short description
• Component has tags
• Component has ci/cd tool linked
• Component has tech-docs linked
• Components contains no typos (vale?)
• Component has a annotation xyz... Here is where it is getting quite specific to the cooperate.

Cooperates might want to provide custom rules on what informations should be available in the catalog.

The plugin should contain an extensible scoring logic, a score display on the entity page, a score display on the team home page and if possible a list of all components sorted by their score.

Context

I wonder if there is already such a plugin at Spotify. Might the tech-insights plugin fall into the same problem space, just for the implementation of a component?

[palmerj3]

We have pretty much this exact tooling on our internal Spotify backstage!

Would there be interest in us open sourcing this and making it a part of backstage?

[Fox32]

We have pretty much this exact tooling on our internal Spotify backstage!

Would there be interest in us open sourcing this and making it a part of backstage?

From my point: sure!

[adamdmharvey]

Potentially tangential to the initial of just having a scoring/gamification plugin, would be allowing _other plugins_ to add into / extend the gamification.

For example, there are repolinters out there that check your GitHub repo uses some best practices such as:

• Existence of README.md
• Existence of CONTRIBUTING.md
• Existence of a LICENSE
• Existence of a .gitignore
• and so on...

These could then introduce an additional scoring badge into the main scoring plugin. Or a scoring badge that gets added to a 3rd party plugin pages as a widget, that sort of thing?