Catalog Registration

Use catalog.entity.register when a mold should add the created service to the Shoehorn catalog.

catalog.entity.register

Registers or updates a catalog entity.

steps:
  - id: register-entity
    name: Register in catalog
    action: catalog.entity.register
    if: "${{ inputs.registerCatalog }}"
    inputs:
      service_id: "${{ inputs.name }}"
      name: "${{ inputs.name }}"
      type: service
      description: "${{ inputs.description }}"
      lifecycle: experimental
      owner: "${{ inputs.team }}"
      tags:
        - golang
        - service
      links:
        - name: Repository
          url: "${{ steps.create-repo.output.html_url }}"
          icon: GitHub

Inputs:

Input	Required	Description
service_id	Yes	Stable catalog ID
name	Yes	Display name
type	Yes	Entity type, such as service
description	No	Description shown in the catalog
lifecycle	No	Lifecycle value, such as experimental or production
owner	No	Owning team or user
tags	No	Catalog tags
links	No	Related links shown on the entity

If registration is optional in the form, add if: "${{ inputs.registerCatalog }}" to the step. Without the condition, Forge runs the step even when the form field is unchecked.

The catalog expects at least one owner when an entity is registered. Make the owner/team field required when catalog registration is always enabled.