diff --git a/CHANGELOG.md b/CHANGELOG.md index 5983427a6b9..079f5df054e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -15,6 +15,37 @@ HydePHP consists of two primary components, Hyde/Hyde and Hyde/Framework. Develo +## [v0.48.0-beta](https://github.com/hydephp/develop/releases/tag/v0.48.0-beta) - 2022-07-10 - Internal Pseudo-Router Service Refactoring + +### About + +This release brings a massive refactor in the way the HydePHP auto-discovery process works. It does this by centralizing all discovery logic to the new pseudo-router module which discovers and maps all source files and output paths. + +The update also refactors related code to use the router. Part of this is a major rewrite of the navigation menu generation. If you have set any custom navigation links you will need to update your configuration files as the syntax has changed to use the NavItem model instead of array keys. + +You will also need to update navigation related Blade templates, if you have previously published them. + +### Added +- Added a pseudo-router module which will internally be used to improve Hyde auto-discovery +- Added a Route facade that allows you to quickly get a route instance from a route key or path +- Added a new NavItem model to represent navigation menu items +- Added a new configuration array for customizing the navigation menu, see the `hyde.navigation` array config + +### Changed +- Changed how the navigation menu is generated, configuration files and published views must be updated +- Changed bootstrap.php to Stt Hyde base path using dirname instead of getcwd +- Reversed deprecation for `StaticPageBuilder::$outputPath` +- internal refactor: Creates a new build service to handle the build process + +### Deprecated +- Deprecated `DiscoveryService::findModelFromFilePath()` - Use the Router instead. +- Deprecated `DiscoveryService.php` - Use the Router instead. (Some helpers may be moved to FluentPathHelpers.php) + +### Removed +- The "no pages found, skipping" message has been removed as the build loop no longer recieves empty collections. +- Removed the `hyde.navigation_menu_links` and `hyde.navigation_menu_blacklist` configuration options, see new addition above. + + ## [v0.47.0-beta](https://github.com/hydephp/develop/releases/tag/v0.47.0-beta) - 2022-07-05 ### Added diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index 558e903af2c..e3d1b60364c 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -1,28 +1,28 @@ -## [Unreleased] - YYYY-MM-DD - Internal Pseudo-Router Service Refactoring +## [Unreleased] - YYYY-MM-DD ### About -This release brings a massive refactor in the way the HydePHP auto-discovery process works. It does this by centralizing all discovery logic to the new pseudo-router module which discovers and maps all source files and output paths. +Keep an Unreleased section at the top to track upcoming changes. -The update also refactors related code to use the router. Part of this is a major rewrite of the navigation menu generation. If you have set any custom navigation links you will need to update your configuration files as the syntax has changed to use the NavItem model instead of array keys. +This serves two purposes: -You will also need to update navigation related Blade templates, if you have previously published them. +1. People can see what changes they might expect in upcoming releases +2. At release time, you can move the Unreleased section changes into a new release version section. ### Added -- Added a pseudo-router module which will internally be used to improve Hyde auto-discovery -- Added a Route facade that allows you to quickly get a route instance from a route key or path -- Added a new NavItem model to represent navigation menu items -- Added a new configuration array for customizing the navigation menu, see the `hyde.navigation` array config +- for new features. ### Changed -- Changed how the navigation menu is generated, configuration files and published views must be updated -- Reversed deprecation for `StaticPageBuilder::$outputPath` -- internal refactor: Creates a new build service to handle the build process +- for changes in existing functionality. ### Deprecated -- Deprecated `DiscoveryService::findModelFromFilePath()` - Use the Router instead. -- Deprecated `DiscoveryService.php` - Use the Router instead. (Some helpers may be moved to FluentPathHelpers.php) +- for soon-to-be removed features. ### Removed -- The "no pages found, skipping" message has been removed as the build loop no longer recieves empty collections. -- Removed the `hyde.navigation_menu_links` and `hyde.navigation_menu_blacklist` configuration options, see new addition above. +- for now removed features. + +### Fixed +- for any bug fixes. + +### Security +- in case of vulnerabilities. diff --git a/package-lock.json b/package-lock.json index f68a7195054..64d059ad0f0 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "hyde", - "version": "0.47.0", + "version": "0.48.0", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "hyde", - "version": "0.47.0", + "version": "0.48.0", "license": "MIT", "devDependencies": { "@tailwindcss/typography": "^0.5.2", diff --git a/package.json b/package.json index 8ec3d8529e1..a89b5c59aac 100644 --- a/package.json +++ b/package.json @@ -8,7 +8,7 @@ "dependencies": {}, "name": "hyde", "description": "Elegant and Powerful Static App Builder", - "version": "0.47.0", + "version": "0.48.0", "main": "hyde", "directories": { "test": "tests" diff --git a/packages/hyde/composer.json b/packages/hyde/composer.json index 1c658321277..9a88be43670 100644 --- a/packages/hyde/composer.json +++ b/packages/hyde/composer.json @@ -21,12 +21,12 @@ ], "require": { "php": "^8.0", - "hyde/framework": "^0.47" + "hyde/framework": "^0.48" }, "require-dev": { "mockery/mockery": "^1.4.4", "pestphp/pest": "^1.21.1", - "hyde/realtime-compiler": "^2.3" + "hyde/realtime-compiler": "^2.4" }, "autoload": { "psr-4": {