|
| 1 | +# Azure Naming Tool - Release Notes v5.0.0 |
| 2 | + |
| 3 | +## Overview |
| 4 | +Version 5.0.0 is a major release featuring .NET 10.0 framework upgrade, modern dashboard redesign, SQLite database support, Azure Tenant Name Validation, enhanced UI/UX, improved configuration management, and API versioning support. |
| 5 | + |
| 6 | +## 🎯 Major Features |
| 7 | + |
| 8 | +### .NET 10.0 Framework Upgrade |
| 9 | +- **Latest .NET version** - Upgraded from .NET 8.0 to .NET 10.0 |
| 10 | +- **Performance improvements** with enhanced runtime efficiency |
| 11 | +- **Security updates** including latest patches and improvements |
| 12 | +- **Modern features** providing access to newest .NET capabilities |
| 13 | +- **Long-term support** for better maintainability |
| 14 | +- **Breaking change:** Requires .NET 10.0 runtime for deployment |
| 15 | +- See [Migration Guide](V5.0.0_MIGRATION_GUIDE.md) for upgrade instructions |
| 16 | + |
| 17 | +### Modern Dashboard Redesign |
| 18 | +- **Two-column hero layout** with logo on left, custom content on right |
| 19 | +- **Configuration Overview stats grid** showing counts for all enabled components |
| 20 | +- **Featured "Names Generated" stat card** with gradient styling |
| 21 | +- **Responsive design** optimized for mobile and desktop |
| 22 | +- **Custom Home Content support** - Markdown editor for personalized welcome messages |
| 23 | +- Fixed component name matching issues (ResourceOrg, ResourceProjAppSvc, ResourceFunction) |
| 24 | +- Improved visual hierarchy and card-based design |
| 25 | + |
| 26 | +### SQLite Database Support |
| 27 | +- **Enhanced performance** with faster data access and queries |
| 28 | +- **Better scalability** for larger configurations |
| 29 | +- **Improved reliability** with transactional support and data integrity |
| 30 | +- **Built-in migration tool** from file-based storage to SQLite |
| 31 | +- **One-click migration** with automatic backup creation |
| 32 | +- **Rollback support** if migration issues occur |
| 33 | +- Admin UI for easy storage provider management |
| 34 | +- Maintains backward compatibility with file-based JSON storage |
| 35 | + |
| 36 | +### Azure Tenant Name Validation |
| 37 | +- **Validate generated names against your Azure tenant** before deployment |
| 38 | +- Prevent naming conflicts by checking if resource names already exist |
| 39 | +- Support for both **Managed Identity** (recommended) and **Service Principal** authentication |
| 40 | +- Flexible conflict resolution strategies: |
| 41 | + - **NotifyOnly** - Warn about conflicts but allow generation (default) |
| 42 | + - **AutoIncrement** - Automatically append incremented suffix (e.g., -001, -002) |
| 43 | + - **Fail** - Block generation if name exists |
| 44 | + - **SuffixRandom** - Add random suffix to resolve conflicts |
| 45 | +- **Performance caching** to minimize Azure API calls |
| 46 | +- **Scoped validation** - configure specific subscription(s) to check |
| 47 | +- **Multi-subscription support** for enterprise deployments |
| 48 | +- Integrated into Site Settings for easy configuration |
| 49 | +- **⚠️ IMPORTANT**: This feature **requires SQLite storage**. You must migrate to SQLite before enabling Azure Tenant Name Validation. |
| 50 | + |
| 51 | +### Modern UI/UX Improvements |
| 52 | +- **Consistent card-based design** across all Admin tabs |
| 53 | +- **Redesigned Admin page** with modern tabbed interface |
| 54 | +- Boxed styling with hover effects for all settings |
| 55 | +- Improved visual hierarchy and spacing |
| 56 | +- Optimized grouped settings (e.g., Site Navigation toggles) |
| 57 | +- **Enhanced toast notifications** with modern styling |
| 58 | +- **Better mobile support** with responsive breakpoints |
| 59 | +- Modern, clean interface throughout the application |
| 60 | + |
| 61 | +### Drag-and-Drop Configuration |
| 62 | +- **Intuitive drag-and-drop sorting** for all configuration lists |
| 63 | +- Replaces up/down arrow controls with drag handles |
| 64 | +- Visual feedback during drag operations |
| 65 | +- Immediate persistence to storage (JSON or SQLite) |
| 66 | +- Supports: Components, Environments, Functions, Locations, Orgs, Projects/Apps/Services, Units/Depts, Custom Components |
| 67 | + |
| 68 | +### API Versioning & Enhancements |
| 69 | +- Support for API versioning (v1 and v2) |
| 70 | +- Separate Swagger documentation for each version |
| 71 | +- v1 endpoints remain stable; v2 enables future enhancements |
| 72 | +- **Bulk operations support** for processing multiple naming requests |
| 73 | +- **Improved error handling** with better error messages and validation |
| 74 | +- **Extended filtering options** for querying configurations |
| 75 | +- No breaking changes to existing v1 APIs |
| 76 | + |
| 77 | +## 🔧 Improvements |
| 78 | + |
| 79 | +### Dashboard & Home Page |
| 80 | +- **New stats grid** showing counts for all enabled resource components |
| 81 | +- **Featured Names Generated card** with gradient background |
| 82 | +- **Custom Home Content editor** now properly initializes with saved content |
| 83 | +- Better organization of quick start guide and feature descriptions |
| 84 | + |
| 85 | +### Data Integrity |
| 86 | +- Fixed ID reassignment issues during list reorders |
| 87 | +- Corrected sort-order behavior when Enabled flag changes |
| 88 | +- Added dedicated UpdateSortOrder APIs for reliable persistence |
| 89 | +- Transactional SQLite saves with proper cache invalidation |
| 90 | +- **Fixed component name matching** for ResourceOrg, ResourceProjAppSvc, and ResourceFunction |
| 91 | + |
| 92 | +### Configuration Management |
| 93 | +- **Backup and Restore** functionality for both JSON and SQLite |
| 94 | +- **Individual component import/export** for granular configuration control |
| 95 | +- **Pre-migration backup creation** before SQLite conversion |
| 96 | +- Enhanced error handling and validation during imports |
| 97 | + |
| 98 | +### Rendering Stability |
| 99 | +- Improved Blazor component rendering with render-key strategy |
| 100 | +- Better JavaScript handler initialization after DOM updates |
| 101 | +- More reliable UI updates across all configuration sections |
| 102 | +- **MarkdownEditor initialization** with proper async loading |
| 103 | + |
| 104 | +### Performance |
| 105 | +- **SQLite database option** for faster queries and better scalability |
| 106 | +- **Improved caching** for Azure validation results |
| 107 | +- Optimized component loading on dashboard |
| 108 | +- Faster configuration page rendering |
| 109 | + |
| 110 | +## 📋 Upgrade Notes |
| 111 | + |
| 112 | +### Migration to v5.0.0 |
| 113 | +- **Review the [v5.0.0 Migration Guide](V5.0.0_MIGRATION_GUIDE.md)** for detailed upgrade instructions |
| 114 | +- **Backup your configuration** before upgrading (use Admin → Configuration → Export) |
| 115 | +- **Site restart required** after deployment and configuration restore |
| 116 | +- Test in a development environment before upgrading production |
| 117 | + |
| 118 | +### Storage Options |
| 119 | +- **FileSystem/JSON** (default): Ensure write permissions to `repository/` and `settings/` folders |
| 120 | +- **SQLite** (recommended for production): Use built-in migration tool in Admin → Configuration |
| 121 | +- **Migration is optional** - file-based storage remains fully supported |
| 122 | +- Backups recommended before migrating to SQLite |
| 123 | + |
| 124 | +### Azure Validation (Optional) |
| 125 | +- Enable in Admin → Site Settings → "Azure Tenant Name Validation" |
| 126 | +- Configure authentication (Managed Identity recommended for Azure deployments) |
| 127 | +- Set conflict resolution strategy based on your naming convention |
| 128 | +- Test connection before saving configuration |
| 129 | +- Requires appropriate Azure RBAC permissions (Reader role minimum) |
| 130 | + |
| 131 | +### Dashboard Customization |
| 132 | +- **Custom Home Content** can be configured in Admin → Customization tab |
| 133 | +- Supports Markdown formatting for rich content |
| 134 | +- **Custom logo** can be uploaded to personalize branding |
| 135 | +- Changes take effect after application restart |
| 136 | + |
| 137 | +### API Compatibility |
| 138 | +- No breaking changes to v1 endpoints |
| 139 | +- v2 endpoints are opt-in and experimental |
| 140 | +- Swagger documentation available at `/swagger/index.html` |
| 141 | + |
| 142 | +## 🐛 Bug Fixes |
| 143 | +- Fixed configuration list ordering persistence issues |
| 144 | +- Resolved Enabled flag affecting sort order |
| 145 | +- Improved client/server data synchronization |
| 146 | +- Fixed spacing inconsistencies in grouped UI elements |
| 147 | +- **Fixed component name mismatches** preventing stats from displaying (ResourceOrg, ResourceProjAppSvc, ResourceFunction) |
| 148 | +- **Fixed Custom Home Content** not loading in MarkdownEditor on Admin page |
| 149 | +- **Fixed isCustomComponent detection** logic to properly identify custom vs. built-in components |
| 150 | +- Resolved focus outline issues on modal dialogs |
| 151 | +- Improved error handling in configuration import/export |
| 152 | +- Fixed cache invalidation after configuration updates |
| 153 | + |
| 154 | +## 📚 Documentation |
| 155 | +For detailed feature guides, see: |
| 156 | +- **[v5.0.0 Migration Guide](V5.0.0_MIGRATION_GUIDE.md)** - Complete upgrade instructions |
| 157 | +- [Azure Validation Admin Guide](AZURE_VALIDATION_ADMIN_GUIDE.md) - Setup and configuration |
| 158 | +- [Azure Validation API Guide](AZURE_VALIDATION_API_GUIDE.md) - API integration |
| 159 | +- [Azure Validation Security Guide](AZURE_VALIDATION_SECURITY_GUIDE.md) - Security best practices |
| 160 | +- [Backup and Restore Guide](BACKUP_RESTORE.md) - Configuration backup procedures |
| 161 | + |
| 162 | +## 🎨 UI/UX Highlights |
| 163 | +- **Modern design system** with consistent spacing, colors, and typography |
| 164 | +- **Card-based layouts** for better content organization |
| 165 | +- **Improved accessibility** with proper focus management |
| 166 | +- **Enhanced mobile experience** with responsive breakpoints |
| 167 | +- **Better visual feedback** with hover states and transitions |
| 168 | +- **Cleaner navigation** with modern tab interface |
| 169 | +- **Professional styling** throughout the application |
| 170 | + |
| 171 | +## 🙏 Acknowledgements |
| 172 | +Thanks to all contributors and testers who helped validate features, identify bugs, and improve the user experience. |
| 173 | + |
| 174 | +--- |
| 175 | +**For issues or questions**, please open a GitHub issue in the repository. |
0 commit comments