Codemods
대상 독자: 개발자 및 관리자 (Audience: Developers and Admins)
출처: 문서
본문
대상 독자: 개발자 및 관리자
패키지를 올리고 create-app / Upgrade Helper 차이점을 검토한 후, Backstage codemods 저장소의 레시피를 실행하세요. 레시피는 Codemod Registry에서 소스 변환의 순서 있는 집합입니다. Codemod CLI로 실행합니다.
이것은 기존의 @backstage/codemods npm 패키지가 아닙니다. 그 패키지는 이 저장소에서 제거되었습니다.
레시피에는 두 가지 종류가 있습니다.
- 버전별 마이그레이션 레시피(Versioned migration recipes)는 특정 Backstage 릴리스에 대한 기계적 파손을 수정합니다 (이름 변경, 해당 릴리스에서 제공된 API 변경 등).
- 기타 레시피(Misc recipes)는 직접 일정을 잡는 더 큰 마이그레이션을 다룹니다 (예: Material-UI에서 Backstage UI로).
버전별 마이그레이션 레시피 (Versioned migration recipes)
업그레이드에 대상 릴리스의 버전별 레시피를 포함하세요. 릴리스 <major>.<minor>.0에 대해 패키지 이름은 @backstage/v<major>-<minor>-0-migration-recipe입니다. 먼저 dry-run, 그다음 적용합니다.
# Example: upgrading toward Backstage 1.52.0yarn dlx codemod run @backstage/v1-52-0-migration-recipe \ --target . \ --dry-runyarn dlx codemod run @backstage/v1-52-0-migration-recipe \ --target .
대상 버전에 대한 레시피가 없으면 이 단계를 건너뜁니다. 게시된 레시피는 codemods README에 나열됩니다.
레시피 실행 후 (After a recipe runs)
저장소에서 TODO(backstage-codemod)를 검색하고 각 마커를 해결하세요. 범위에서 빠진 것 중 손으로 여전히 변경해야 하는 것이 있는지 해당 레시피의 README를 읽으세요.
기타 레시피 (Misc recipes)
기타 레시피는 단일 릴리스에 속하지 않는 마이그레이션을 위한 것입니다. 그 마이그레이션을 의도하지 않는 한 일상적인 업그레이드에서는 건너뛰세요.
Material-UI 4에서 Backstage UI로
mui-to-bui-migration 스킬은 이 레시피를 실행하고 남은 부분을 마무리하거나, 독립형 안내로 직접 마이그레이션하는 것을 지원합니다. 기계적 변경에는 레시피를 권장하고 경로 선택은 사용자의 몫으로 존중합니다. 독립형 경로는 codemod 실행이 필요 없습니다.
레시피를 사용하려면 mui4-to-bui-migration-recipe README를 읽은 다음 dry-run하고 적용합니다.
yarn dlx codemod run @backstage/mui4-to-bui-migration-recipe \ --target . \ --dry-runyarn dlx codemod run @backstage/mui4-to-bui-migration-recipe \ --target .
다음 단계 (Next steps)
- 레시피 색인: github.com/backstage/codemods
- 레지스트리: go.codemod.com/backstage
- 업그레이드 과정: Keeping Backstage Updated