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