Backstage catalog standardization

Backstage uses catalog-info.yaml files to register services in your developer portal. This automation creates or updates those files to match your organization's Backstage RFC, validates them, and opens a PR.

How to use this template

  1. 1Click "Use this template" or create a new automation in Ona
  2. 2Set your trigger (manual, scheduled, or event-based)
  3. 3Copy each step below into the automation builder
  4. 4Customize the prompts for your specific use case

What this does

  • Auto-generate catalog-info.yaml from codebase analysis
  • Validate against your Backstage RFC
  • Ensure consistent metadata across repos
  • Open PRs with validated catalog entries

Workflow

Trigger

Manual trigger

Select repositories to generate or update Backstage catalog entries.

Prompt

Fetch RFC requirements

Analyze the Backstage catalog standardization RFC. Extract required fields, acceptable values, and validation rules.

Prompt

Analyze repository

Detect component type, ownership, dependencies, technology stack, and API definitions.

Prompt

Generate catalog-info.yaml

Create or update catalog-info.yaml with automated fields. Add TODO comments for fields requiring human input.

Shell Script

Validate

npm install --global @roadiehq/backstage-entity-validator && validate-entity catalog-info.yaml
Pull Request

Open PR

Submit a draft pull request with the catalog-info.yaml changes and a review checklist.

More automations to explore.

Ready to try a template?

Start building with a free Ona account.

Copied to clipboard!

This website uses cookies to enhance the user experience. Read our cookie policy for more info.