Upgrading Django Unfold
Before upgrading, always:- Review the changelog for your target version
- Test in a development environment first
- Back up your database before applying migrations
- Review custom templates if you’ve overridden any Unfold templates
From v0.81.x to v0.82.x
Required Changes
-
Upgrade Python version:
-
Update package:
- Test your admin interface for any breaking changes in custom templates or widgets
New Features
- UnfoldAdminRelatedFieldWrapperWidget: Enhanced widget for related field rendering
- Improved fieldset collapse functionality with better icon placement
From v0.80.x to v0.81.x
Tailwind 4.2 Upgrade
This version includes Tailwind CSS 4.2. If you’ve customized Tailwind:- Review custom Tailwind configurations in your project
- Check for any deprecated Tailwind classes in your templates
- Rebuild custom styles if you’re using Unfold’s Tailwind customization
Update Steps
From v0.7x.x to v0.80.x
Breaking Changes
Update Steps
-
Update widget imports if you’re using custom widgets:
- Review button styling - default button variants now include shadows
- Check table hover colors if you’ve customized table styling
From v0.6x.x to v0.70.x
Datasets Feature
Version 0.68.0 introduced the Datasets feature. If upgrading:- Review custom changelist implementations for compatibility
- Check facet configurations for Django 4.2 compatibility
Update Steps
From v0.5x.x to v0.60.x
Command Palette
Version 0.64.0 introduced the command palette feature:The command palette is enabled by default. To disable it, add
"SHOW_COMMAND_PALETTE": False to your UNFOLD settings.Breaking Changes
- Tab navigation redesign: Custom tab styles may need updates
- OKLCH color system: If you’re using custom colors, consider migrating to OKLCH
Common Migration Issues
Static Files Not Loading
After upgrading, always run:Custom Templates Breaking
If you’ve overridden Unfold templates:- Compare your templates with the new version
- Check template block names - they may have changed
- Review component usage in templates
Missing Icons or Styles
Clear your browser cache and rebuild static files:Testing After Migration
After upgrading, test these critical areas:Checklist: Post-Migration Testing
Checklist: Post-Migration Testing
- Login and authentication pages
- Dashboard and custom pages
- Model list views (changelist)
- Model detail views (changeform)
- Inline formsets
- Custom filters and actions
- Third-party integrations (import-export, simple-history, etc.)
- Dark mode switching
- Mobile responsiveness
- Custom dashboard components
Getting Help
If you encounter issues during migration:Troubleshooting
Common issues and solutions
Discord Community
Get help from the community
GitHub Issues
Report bugs or request features
Professional Support
Get expert assistance