Register Catalog Entities - Backstage Scaffolder Action

Description

Registers entities from a catalog descriptor file in the workspace into the software catalog.

Input Schema

Property	Type	Description
enum	any	-
type	any	-
items	any	-
optional	any	-
description	any	-

Output Schema

No output schema defined for this action.

Usage Examples

Register a newly published GitHub repository catalog descriptor

Registers the catalog-info.yaml from the repository you just published. Use this immediately after publish:github to add the new component to the catalog.

yaml

steps:
  - id: fetch-base
    action: fetch:template
    input:
      url: ./skeleton
      targetPath: .
      values:
        componentId: ${{ parameters.componentId }}
        owner: ${{ parameters.owner }}
        description: ${{ parameters.description }}

  - id: publish
    action: publish:github
    input:
      repoUrl: github.com?owner=acme-inc&repo=${{ parameters.componentId }}
      description: ${{ parameters.description }}
      defaultBranch: main
      repoVisibility: private

  - id: register
    action: catalog:register
    input:
      repoContentsUrl: ${{ steps.publish.output.repoContentsUrl }}
      catalogInfoPath: /catalog-info.yaml

Register an existing repository descriptor by URL

Registers a catalog descriptor that already exists in a remote repository. Use this to onboard an existing project without publishing new code, optionally after gathering inputs with fetch:template.

yaml

steps:
  - id: register-existing
    action: catalog:register
    input:
      catalogInfoUrl: ${{ parameters.catalogInfoUrl }}

Other actions in @backstage/plugin-scaffolder-backend

Delete Files And Directories

Deletes files and directories from the workspace

1 input, 0 outputs

Available on Roadie

Dry run

Download File to Workspace

Downloads single file and places it in the workspace.

8 inputs, 0 outputs

Dry run

Download File to Workspace

Downloads single file and places it in the workspace.

3 inputs, 0 outputs

Available on Roadie

Dry run

Dry Run Extraction

Simulates the extraction process without making actual changes or modifications.

0 inputs, 0 outputs

Dry run

Fetch And Template Files

Downloads a skeleton, templates variables into it, and places the result in the workspace, or in a subdirectory.

11 inputs, 0 outputs

Available on Roadie

Dry run

Fetch Catalog Entities

Returns entity or entities from the catalog by entity reference(s)

5 inputs, 2 outputs

Available on Roadie

Dry run

Fetch Plain Content

Downloads content and places it in the workspace, or optionally in a subdirectory specified by the targetPath input option.

3 inputs, 0 outputs

Available on Roadie

Dry run

List Workspace Contents

Reads files and directories from the workspace

2 inputs, 2 outputs

Available on Roadie

Dry run

Log And List Files

Writes a message into the log and/or lists all files in the workspace.

2 inputs, 0 outputs

Available on Roadie

Dry run

Pause For Duration

Waits for a certain period of time.

3 inputs, 0 outputs

Available on Roadie

Rename Files and Directories

Renames files and directories within the workspace

1 input, 0 outputs

Available on Roadie

Dry run

Render Workspace Templates

Templates variables into file and directory names and content in the action context workspace.

7 inputs, 0 outputs

Dry run

Template File Renderer

Templates variables into a single workspace file, placing the result into another location in the workspace.

5 inputs, 0 outputs

Dry run

Write Catalog Info File

Writes the catalog-info.yaml for your template

2 inputs, 0 outputs

Available on Roadie

Dry run