Skip to content

docs: add catalog-info.yaml config file to import into Varia - #4323

Closed
emirgens wants to merge 4 commits into
mainfrom
varia/add-catalog-info-file
Closed

docs: add catalog-info.yaml config file to import into Varia#4323
emirgens wants to merge 4 commits into
mainfrom
varia/add-catalog-info-file

Conversation

@emirgens

@emirgens emirgens commented Dec 9, 2025

Copy link
Copy Markdown
Collaborator

This pull request adds a Backstage entity metadata file to this repository so that the component can be added to the Varia software catalog.

After this pull request is merged, the component will become available.

For more information, read an overview of the Backstage software catalog.

Copilot AI review requested due to automatic review settings December 9, 2025 14:09
@emirgens emirgens self-assigned this Dec 9, 2025

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request adds a Backstage catalog metadata file (catalog-info.yaml) to enable the Equinor Design System repository to be registered in the Varia software catalog. This is an infrastructure configuration change that makes the component discoverable and manageable through Backstage's software catalog system.

Key Changes:

  • Adds catalog-info.yaml with Backstage v1alpha1 entity metadata
  • Configures component metadata including name, type, lifecycle, and ownership
  • Links the component to its GitHub repository using project slug annotation

Comment thread catalog-info.yaml Outdated
Comment thread catalog-info.yaml Outdated
Copilot AI review requested due to automatic review settings December 9, 2025 14:29
@emirgens emirgens changed the title Add catalog-info.yaml config file docs: add catalog-info.yaml config file to import into Varia Dec 9, 2025

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 3 comments.

Comment thread catalog-info.yaml Outdated
Comment thread catalog-info.yaml Outdated
Comment thread catalog-info.yaml
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings December 9, 2025 14:32
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (1)

catalog-info.yaml:72

  • Duplicate component definition detected. The component eds-color-palette-generator is defined twice (lines 46-57 and lines 61-72) with identical content. This will cause conflicts in the Backstage catalog. Remove one of these duplicate entries.
apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
  name: eds-color-palette-generator
  description: EDS Tool for generating accessible color palettes
  annotations:
    github.com/project-slug: equinor/design-system
spec:
  type: tool
  lifecycle: production
  owner: eds-core
  system: EquinorDesignSystem

@vnys

vnys commented Dec 11, 2025

Copy link
Copy Markdown
Contributor

If the purpose of this config file is to give users access to EDS resources, then I would think that the core-react, tokens and icons is what most people are looking for. I don’t think adding the colour-generator and demo app adds any value. 🤔

@vnys

vnys commented Dec 11, 2025

Copy link
Copy Markdown
Contributor

I was looking for a yaml schema file to validate the contents of the file, there’s a VS Code extension that makes it easier to write catalog-info.yaml files: https://marketplace.visualstudio.com/items?itemName=vatess.backstage-catalog-helper

@emirgens emirgens closed this Dec 11, 2025
@emirgens
emirgens deleted the varia/add-catalog-info-file branch December 11, 2025 13:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants