From f0c970643dd8d73ae42de12cf7be89ea8ad735c4 Mon Sep 17 00:00:00 2001 From: Maximilian Franzke <787658+mfranzke@users.noreply.github.com> Date: Mon, 9 Dec 2024 17:04:32 +0100 Subject: [PATCH] docs: added relevant migration section (#3576) --- docs/migration/v0.5.x-to-v0.6.x.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/migration/v0.5.x-to-v0.6.x.md b/docs/migration/v0.5.x-to-v0.6.x.md index cd9114c2558..da206f41d3b 100644 --- a/docs/migration/v0.5.x-to-v0.6.x.md +++ b/docs/migration/v0.5.x-to-v0.6.x.md @@ -20,3 +20,13 @@ We changed some properties for components to align with Figma properties: - `variant="hidden"` ➡️ `showLabel="true/false"` - Defaults to `true` - `customValidity` ➡️ `validation` + +## Automate migration via CLI + +We provide a cli tool to auto migrate your source code. Use this command in your repository: + +```shell +npx @db-ui/foundations@v0.6 migration --type=v005_v006 --src=./src +``` + +Please check the changes made in your codebase afterwards, as this is mainly a simple search & replace and there might be unexpected changes of similar wordings to our icon names for any other methods, or further code occurrences that don't even refer to icons.