Overview#
Describe what is being migrated (e.g., v1 to v2, old system to new system) and why.
Before You Start#
- Back up your data
- Review breaking changes below
- Verify you meet the new prerequisites
Breaking Changes#
| Change | Before | After | Action Required |
|---|---|---|---|
| Example change | Old behavior | New behavior | What to update |
Migration Steps#
Step 1: Update dependencies#
# Example
npm install package@latest
Step 2: Update configuration#
Describe configuration changes needed.
Step 3: Update code#
Describe code changes needed, with before/after examples.
Before:
oldFunction(arg)
After:
newFunction(arg, options)
Step 4: Run migrations#
# Example
npm run migrate
Validation#
How to verify the migration was successful:
- Run the test suite
- Check key functionality
- Monitor logs for errors
Rollback#
If something goes wrong:
- Rollback step 1
- Rollback step 2
Known Issues#
- Known issue and workaround