Skip to main content

Scorecards

Scorecards is a powerful validation framework in Venue.sh that ensures your Backstage entities meet defined standards. It uses customizable rules to validate entities in real time, checking for required metadata, specifications, and annotations. Each rule acts as a quality gate, providing clear pass/fail metrics to help you track compliance and identify areas that need attention.

Venue.sh comes with four pre-installed golden rules, maintained by the Venue.sh team, to ensure consistent quality standards.

note

This is the first iteration of the Scorecards feature. The Venue.sh team is already working on a more robust version with additional expressions. Coming soon!

Benefits​

Scorecards provide many advantages for your development workflow, including:

  • Quality assurance by ensuring all entities meet required standards,
  • Integration validation by verifying proper tool configurations,
  • Compliance monitoring by tracking validation statuses in real-time,
  • Standardization by maintaining consistency across your catalog, and
  • Clear metrics by easily identifying areas that need attention.

Golden Rules​

The following rules are configured out of the box and ready to use in your Venue.sh instance:

  • API Rule - Validates API entities by ensuring they have all required metadata and specifications. This rule checks for essential fields, like Name, Type, Lifecycle, Owner, and Definition.

  • Component Rule - Ensures component entities have complete metadata and specifications. This rule validates critical fields, including Name, Type, Lifecycle, and Owner.

  • GitLab Rule - Validates GitLab integration settings by checking for required annotations. This rule ensures proper GitLab instance and project slug configurations.

  • Jira Rule - Verifies Jira integration settings through annotation validation. This rule checks for proper Jira project key configuration.

Here's an example of the golden rules and the feedback they provide:

Example of the four pre-installed golden rules in Scorecards

Writing Rules​

Each Scorecards rule requires the following information:

  • Name - A unique identifier for the rule
  • Description - Clear purpose of the validation
  • Selector - Entity type the rule applies to. It uses the expression language to select the entities.
  • Criteria - Required conditions for validation. It uses the expression language to validate the entities.
  • Owner - Team responsible for maintenance
  • Tags - Categories for organization
caution

Give your new rule a name before adding values to the other rule-creation fields, or the rule may not work properly. We'll fix this issue soon.

Here's an example of an API rule:

Scorecards rule creation

tip

Detailed information about rule syntax and writing expressions can be found on the Expressions page.