Bbackstage

backstage/remove-immediate-stitching-mode

Backstage 1.51.0: Migrate catalog.stitchingStrategy.mode from immediate to deferred

backstagemigrationcatalogstitching1.51.0
Public
0 executions

Run locally

npx codemod @backstage/remove-immediate-stitching-mode

remove-immediate-stitching-mode

Backstage 1.51.0 codemod: Migrates catalog.stitchingStrategy.mode: immediate to deferred in app-config YAML files.

Background

In Backstage 1.51.0, catalog.stitchingStrategy.mode: immediate is deprecated. A warning is logged on startup when immediate mode is configured. Immediate mode will be removed in a future Backstage release. Deferred mode is the default.

What it does

  • Scans app-config.yaml and app-config.*.yaml files
  • Finds catalog.stitchingStrategy.mode: immediate (any quoting style)
  • If stitchingStrategy only contains mode: immediate, removes the entire block (deferred is the default)
  • If other stitchingStrategy keys exist, changes only mode to deferred
  • Adds a migration comment under catalog documenting the change

Usage

bash

Before / After

yaml
yaml

When other stitching settings are present:

yaml
yaml

Notes

  • Environment-specific config files (app-config.production.yaml, etc.) are included in the scan.
  • Files already using mode: deferred or without a stitchingStrategy block are left unchanged.

Ready to contribute?

Build your own codemod and share it with the community.