Skip to content

[xRef-339] Add catalog-info.yaml for repo governanceΒ #17

Description

@y9886887

πŸ“‹ Repo Governance β€” catalog-info.yaml Required

Your repository does not have a catalog-info.yaml file at its root.

This file is required by the DigitalInnovation org standard and powers the Muziris Developer Portal. It enables:

  • Ownership tracking β€” who is responsible for this service
  • Discoverability β€” teams can find and understand your service
  • Engineering metrics β€” DORA, reliability, and platform insights
  • Architectural visibility β€” connects your code to products and domains

Steps to fix

  1. Decide the lifecycle of this repo:
    • production β€” actively used by customers or internally β†’ use Template A below
    • experimental β€” learning project, hackathon, POC β†’ use Template B below
    • deprecated β€” end of life β†’ use Template B below
  2. Create catalog-info.yaml in the root of your main branch
  3. For deployed services: find your Application ID (ap-AXXXX) in Ardoq
  4. Find your team slug in the Muziris group catalog (e.g. tn-cloud-9-devsecops)

Template A β€” Production service (full)

apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
  name: .github       # Kebab lower-case, globally unique
  title: Your App Name       # Human readable display name
  description: "<Clear description of what the component is and does>"
  annotations:
    github.com/project-slug: DigitalInnovation/.github   # Required
    # pagerduty.com/service-id: ABC123           # Optional: from PagerDuty service URL
    # sonarqube.org/project-key: DigitalInnovation_key  # Optional: from sonarcloud.io
    # newrelic.com/dashboard-guid: GUID          # Optional: from New Relic dashboard URL
    # mnscorp.net/support-url: https://teams.microsoft.com/...  # Optional: Teams channel
spec:
  type: service   # service | library | website | template | platform | documentation
                  # tests | mobile-app | pipelines | reusable-github-actions |
                  # infrastructure | job | fullstack | script | data
  owner: tn-your-team-name   # ← Team slug from Muziris group catalog (link above)
  system: ap-AXXXX           # ← Application ID from Ardoq (required for all deployed services)
  lifecycle: production

Template B β€” Experimental / deprecated (minimal)

apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
  name: .github
  title: Your App Name
  description: "<Brief description of what the code does>"
  annotations:
    github.com/project-slug: DigitalInnovation/.github
spec:
  type: service               # Choose the most appropriate type (see list above)
  owner: tn-your-team-name    # ← Team slug from Muziris group catalog
  lifecycle: experimental     # or: deprecated

Useful links


No longer needed? If this repository is no longer required, consider archiving it instead of adding a catalog file. See repos-for-archiving for the archival process.


Raised automatically as part of xRef-339 Repo Governance. Contact the Cloud DevSecOps team if you have questions.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    xref-339xRef-339 Repo Governance

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions