Get Roadie in your IDE with our new MCP Servers
Roadie
← Backstage Scaffolder Actions

Dry Run Extraction

Action ID: dry-run:extract
NPM Package:

@backstage/plugin-scaffolder-backend

Description

Simulates the extraction process without making actual changes or modifications.

Input Schema

No input schema defined for this action.

Output Schema

No output schema defined for this action.

Usage Examples

Preview extraction after fetching a service template

Run a dry extraction after pulling a template with fetch:template. Use this to validate which files would be extracted without modifying the workspace.

Copy 
steps:
  - id: fetch-template
    action: fetch:template
    input:
      url: https://github.com/example-org/service-template
      targetPath: .
      values:
        name: ${{ parameters.name }}
        owner: ${{ parameters.owner }}
        description: Basic HTTP service

  - id: preview-extraction
    action: dry-run:extract

Conditionally preview extraction for a submodule in a monorepo

Only run a dry extraction for a specific module path when previewOnly is true. This helps inspect what would be extracted for one module in a larger template.

Copy 
steps:
  - id: fetch-monorepo-template
    action: fetch:template
    input:
      url: https://github.com/example-org/monorepo-template
      targetPath: .
      values:
        repoName: ${{ parameters.repoName }}
        moduleName: ${{ parameters.moduleName }}
        owner: ${{ parameters.owner }}

  - id: preview-module-extraction
    if: ${{ parameters.previewOnly }}
    action: dry-run:extract
    workingDirectory: ${{ parameters.moduleDir }}

Other actions in @backstage/plugin-scaffolder-backend

List Workspace Contents

Reads files and directories from the workspace

Available on Roadie
Dry run

Pause For Duration

Waits for a certain period of time.

3 inputs, 0 outputs
Available on Roadie

Register Catalog Entities

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

5 inputs, 0 outputs
Available on Roadie

Fetch Catalog Entities

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

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

Fetch And Template Files

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

Available on Roadie
Dry run

Log And List Files

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

Available on Roadie
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

Fetch Plain Content

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

Available on Roadie
Dry run

Delete Files And Directories

Deletes files and directories from the workspace

Available on Roadie
Dry run

Write Catalog Info File

Writes the catalog-info.yaml for your template

Available on Roadie
Dry run

Rename Files and Directories

Renames files and directories within the workspace

Available on Roadie
Dry run

Download File to Workspace

Downloads single file and places it in the workspace.

Available on Roadie
Dry run

Download File to Workspace

Downloads single file and places it in the workspace.

8 inputs, 0 outputs
Dry run