Skip to main content

Scorecards as code

Once Scorecards are incorporated into your regular engineering workflows, they become production-grade tools. Scorecards set the benchmarks for how your organization defines “good,” which impacts everything from security standards to on-call rotations. Because Scorecards are crucial to achieving and maintaining standards, you likely want to employ some kind of controlled access and version controlling.

With Scorecards as code, you can treat your Scorecard like any other production asset. This feature lets you manage Scorecards through GitOps, just like you’d manage the entities in your catalogs. Every Scorecard has its own YAML file (you can learn more about Scorecard YAML formatting here). When GitOps is enabled, changes made to Scorecards will appear in GitOps logs, just like when changes are made to other entities.

Setting up Scorecards as code​

To migrate to Scorecards as code, navigate to Scorecards in Workspace settings.

Toggle off Enable Scorecard UI Editor. Once the feature is disabled, Cortex will automatically process any Scorecard YAML files within your Git repositories.

scorecards as code 1

Converting an existing Scorecard to code​

To convert an existing Scorecard into code, navigate to the Scorecard's details page and select the vertical ellipsis (⋮). Then, select Export Scorecard.

This will download a YAML version of your Scorecard.

Scorecards as code is designed to reduce as much friction as possible when working with Scorecards, so you can continue to make the most of this flexible tool.