v5.0.0 Updates #173
Merged
v5.0.0 Updates #173
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Wiki documentation preparation (all links fixed for GitHub Wiki format) - Created API_HOME landing page - API V2 implementation with complete endpoint coverage - Added Azure Validation feature with Docker support - Updated to .NET 10 with comprehensive migration guide - Added SQLite configuration repository support - UI/UX improvements and Bootstrap 5 modal updates - Added comprehensive unit tests (300+ tests) - Configuration enhancements and cache improvements - Added health checks and middleware - Updated NuGet packages to latest versions - Added .gitignore rules to prevent large file commits - Workflow documentation for fork/PR process Fixes: - Configuration page cache clear hang - Actions Legend modal opacity - Chevron rotation on log pages - Resource delimiter selection issues - API route template syntax for APIM compatibility - Azure Validation settings migration
v5.0.0 Complete Updates - API V2, Azure Validation, .NET 10, Wiki Docs
- Add SanitizeForLog helper methods to ApiLoggingMiddleware and AzureValidationService - Sanitize all user-controlled input (Method, Path, QueryString, ResourceType) before logging - Prevents log injection attacks (CodeQL alerts) - Fix hardcoded absolute path in convert-services.ps1 - Fix corrupted emoji character in migration guides (� → 🔴) Addresses all Copilot and CodeQL security recommendations from PR #171
Security fixes: Sanitize user input in logs (CodeQL High Severity)
Contributor
There was a problem hiding this comment.
Pull request overview
This PR introduces comprehensive v5.0.0 updates focusing on wiki documentation preparation, configuration enhancements, and repository cleanup. The changes include creation of extensive API documentation, migration guides, validation guides, and development scripts, along with formatting updates to the README.
Key Changes
- Created comprehensive wiki documentation for API v1, v2, Azure validation, and migration guides (7 new wiki files, 5,000+ lines)
- Added development helper scripts for code maintenance (fix-warnings.ps1, convert-services.ps1)
- Updated main README documentation link formatting
- Prepared documentation for GitHub Wiki deployment with proper internal linking
Reviewed changes
Copilot reviewed 29 out of 255 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| scripts/development/fix-warnings.ps1 | PowerShell script to automate fixing CS0168 unused exception variable warnings |
| scripts/development/convert-services.ps1 | Helper script to identify service files requiring conversion/refactoring |
| docs/v5.0.0/wiki/v5.0.0.md | Comprehensive v5.0.0 release notes with all major features and upgrade notes |
| docs/v5.0.0/wiki/V5.0.0_MIGRATION_GUIDE.md | Detailed migration guide with backup procedures, deployment steps, and troubleshooting |
| docs/v5.0.0/wiki/AZURE_NAME_VALIDATION_GUIDE.md | Complete guide for Azure tenant name validation feature setup and usage |
| docs/v5.0.0/wiki/AZURE_NAME_VALIDATION_DOCKER_WIKI.md | Docker-specific deployment guide for Azure validation feature |
| docs/v5.0.0/wiki/API_V2.md | API version 2.0 documentation with enhanced features and examples |
| docs/v5.0.0/wiki/API_V1.md | API version 1.0 documentation for backward compatibility |
| docs/v5.0.0/wiki/API.md | API documentation landing page comparing v1 and v2 |
| docs/v5.0.0/testing/BACKUP_RESTORE.md | Guide for backup and restore procedures across storage providers |
| docs/v5.0.0/testing/AZURE_VALIDATION_TESTING_GUIDE.md | Comprehensive testing guide with test suites and automation scripts |
| docs/v5.0.0/testing/AZURE_VALIDATION_SECURITY_GUIDE.md | Security guide covering authentication, RBAC, and credential management |
| docs/v5.0.0/testing/AZURE_VALIDATION_MIGRATION_FIX.md | Documentation of Azure validation settings migration fix |
| docs/v5.0.0/development/PHASE5_UI_INTEGRATION_SUMMARY.md | Implementation summary for Phase 5 UI integration |
| docs/v5.0.0/development/AZURE_VALIDATION_FEATURE_COMPLETE.md | Complete feature implementation summary with 8 phases |
| docs/v5.0.0/RELEASE_NOTES_v5.0.0.md | Release notes for v5.0.0 with all features and upgrade notes |
| docs/v5.0.0/README.md | Documentation index and organization guide |
| README.md | Updated documentation link formatting |
Comments suppressed due to low confidence (1)
docs/v5.0.0/wiki/AZURE_NAME_VALIDATION_GUIDE.md:1
- The documentation states Strategy must be numeric (0, 1, 2) but the example at line 649 shows using string values ('ServicePrincipal', 'NotifyOnly'). This inconsistency could confuse users about the correct format.
# Azure Validation Feature
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Add note explaining to use string values in config files - Expand table to show both string values and numeric mappings - Prevents confusion about which format to use Addresses Copilot recommendation
The method declaration was accidentally omitted in the previous commit. Build now succeeds with 0 errors.
Follow-up fixes: Documentation clarity and build fix
Remove WORKFLOW_GUIDE.md - not needed in repository
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
This PR includes comprehensive v5.0.0 updates focusing on wiki documentation preparation, configuration enhancements, and repository cleanup.
Wiki Documentation
API_HOME.md).mdextensions, hyphen-separated names)API_V1_WIKI.mdAPI_V2_WIKI.mdAZURE_VALIDATION_WIKI.mdAZURE_VALIDATION_DOCKER_WIKI.mdRELEASE_NOTES_v5.0.0.mdV5.0.0_MIGRATION_GUIDE.mdConfiguration & Code Improvements
Repository Cleanup
Testing
Documentation
All wiki documentation is ready for deployment to: https://github.com/mspnp/AzureNamingTool/wiki