Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Add hint to @comet/upgrade #1637

Merged
merged 2 commits into from
Jan 30, 2024
Merged

Docs: Add hint to @comet/upgrade #1637

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e3a772d
Docs: Add hint to @comet/upgrade
dkarnutsch Jan 30, 2024
7d7dacf
Docs: Add introduction to migration chapter
dkarnutsch Jan 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/docs/migration/index.md
View file
Open in desktop
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.

:::
Loading