Skip to content

Commit

Permalink
Docs: Add hint to @comet/upgrade (#1637)
Browse files Browse the repository at this point in the history
  • Loading branch information
dkarnutsch authored Jan 30, 2024
1 parent 33e3b7a commit dbfc979
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions docs/docs/migration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,21 @@
title: Migration
sidebar_position: 12
---

This chapter contains instructions for migrating from one COMET DXP version to another.

## @comet/upgrade

Codemods for automated updates, such as renames, are available at [@comet/upgrade](https://github.com/vivid-planet/comet-upgrade).

Example usage for upgrading from v4 to v5 (each major version should be upgraded separately):

```
npx @comet/upgrade v5
```

:::caution

Codemods are designed to ensure that upgrades are as smooth as possible, so their use is highly recommended.

:::

0 comments on commit dbfc979

Please sign in to comment.