Releases: hydephp/develop
v2.0.0
What's Changed
- [2.x] Set up HydePHP v2 by @emmadesilva in #1497
- [2.x] Rewrite documentation search page internals to be based on dynamic pages instead of a build task by @emmadesilva in #1498
- [2.x] Refactor media asset transferring to be in a build task by @emmadesilva in #1536
- [2.x] Add conditional semantic documentation article rendering by @emmadesilva in #1566
- [2.x] Remove unused internal
DocumentationSearchPage::generate()method by @emmadesilva in #1569 - [2.x] Change default DocumentationPage group to be
nullinstead of'other'by @emmadesilva in #1572 - [2.x] Remove duplicate navigation item filtering by @emmadesilva in #1573
- [2.x] Change NavItem class API to be fluent instead of readonly by @emmadesilva in #1574
- [2.x] Improved navigation group label generation by @emmadesilva in #1576
- [2.x] Simplify dropdown data handling by @emmadesilva in #1577
- [2.x] Refactor navigation menu generators by @emmadesilva in #1578
- [2.x] Merge menu generator actions into single class by @emmadesilva in #1579
- [2.x] Split out base navigation menu class from main menu class by @emmadesilva in #1580
- [2.x] Refactor navigation menu container bindings by @emmadesilva in #1581
- [2.x] Breaking: Change configuration option
docs.sidebar_ordertodocs.sidebar.orderby @emmadesilva in #1583 - [2.x] Breaking: Change configuration option
docs.table_of_contentstodocs.sidebar.table_of_contentsby @emmadesilva in #1584 - [2.x] Support setting sidebar labels and visibility in docs config by @emmadesilva in #1586
- [2.x] Massively simplify sidebar footer text handling by @emmadesilva in #1594
- [2.x] Refactor sidebar data handling by @emmadesilva in #1587
- [2.x] Always place navigation menu items in dropdowns when set in front matter by @emmadesilva in #1597
- [2.x] Create positioning priority constants in the navigation menu class by @emmadesilva in #1598
- [2.x] Refactor NavItem class by @emmadesilva in #1599
- [2.x] Rename NavItem fields to normalize its API by @emmadesilva in #1600
- [2.x] Extract back NavItem class for dropdowns by @emmadesilva in #1601
- [2.x] Create HTML tests for the navigation layouts by @emmadesilva in #1605
- [2.x] Clean up navigation view markup by @emmadesilva in #1606
- [2.x] Normalize navigation HTML ID naming by @emmadesilva in #1622
- [2.x] Expand abbreviated navigation item class names by @emmadesilva in #1625
- [2.x] Restructure navigation item class design to use composition over inheritance by @emmadesilva in #1626
- [2.x] Simplify navigation item group state handling to be deterministic by @emmadesilva in #1632
- [2.x] Create new navigation destination class to replace external routes by @emmadesilva in #1636
- [2.x] Simplify the navigation items class by @emmadesilva in #1637
- [2.x] Create better fallbacks when not supplying a navigation item label by @emmadesilva in #1638
- [2.x] Remove the group property from the navigation item class by @emmadesilva in #1639
- [2.x] Remove the
NavigationElementcontract by @emmadesilva in #1640 - [2.x] Extract trait for shared code with navigation menu class by @emmadesilva in #1630
- [2.x] Merge trait back into menu class and make navigation groups extend the menu class by @emmadesilva in #1645
- [2.x] Simplify and normalize public navigation APIs by @emmadesilva in #1642
- [2.x] Rewrite navigation internals by @emmadesilva in #1568
- [2.x] Refactor features class to be a kernel singleton by @emmadesilva in #1647
- [2.x] Refactor features class to simplify it and extract an enum by @emmadesilva in #1649
- [2.x] Change default build task message to make it more concise by @emmadesilva in #1659
- [2.x] Simplify the Feature enum class by @emmadesilva in #1651
- [2.x] Clean up and refactor code by @emmadesilva in #1665
- [2.x] Refactor filesystem helpers by @emmadesilva in #1698
- [2.x] Honour front matter navigation groups set in front matter regardless of subdirectory setting by @emmadesilva in #1704
- [2.x] Calling the
Include::path()method will no longer create the directory by @emmadesilva in #1707 - [2.x] Support automatic navigation priorities by prefixing a number in filenames by @emmadesilva in #1709
- [2.x] Improve the numerical filename priority prefix feature by @emmadesilva in #1710
- [2.x] DataCollections improvements by @emmadesilva in #1732
- [2.x] Includes facade improvements by @emmadesilva in #1738
- [2.x] Update the
routehelper function to throw if the route does not exist by @emmadesilva in #1741 - [2.x] Even smarter sitemap generation by @emmadesilva in #1744
- [2x] Use a non-zero exit code 3 when skipping build tasks by @emmadesilva in #1749
- [2.x] Remove the deprecated global
unslashfunction by @emmadesilva in #1754 - [2.x] Remove the deprecated
BaseUrlNotSetExceptionclass by @emmadesilva in #1760 - [2.x] Overhaul the blog post authors feature by @emmadesilva in #1782
- [2.x] Add an invalid configuration exception class by @emmadesilva in #1799
- [2.x] Update custom exception class to accept previous throwable by @emmadesilva in #1800
- [2.x] Clean up author code by @emmadesilva in #1819
- [2.x] Support setting extra attributes for navigation items by @emmadesilva in #1824
- [2.x] Add a navigation config builder class by @emmadesilva in #1827
- [2.x] Clean up the navigation documentation by @emmadesilva in #1828
- [2.x] Clean up the navigation and sidebar documentation by @emmadesilva in #1838
- [2.x] Move the sidebar documentation to the documentation pages page by @emmadesilva in #1841
- [2.x] Unify the Navigation API by @emmadesilva in #1818
- [2.x] Add booting and booted callbacks to the HydeExtension feature by @emmadesilva in #1847
- [2.x] Fix realtime compiler search index serving by @emmadesilva in #1878
- [2.x] Remove deprecated method
FeaturedImage::isRemote()by @emmadesilva in #1883 - [2.x] Update blog posts to use
BlogPostingSchema.org type by @emmadesilva in #1887 - [2.x] Add more rich markup data to blog post components by @emmadesilva in #1888
- [2.x] Revert to throwing an exception when trying to get non-configured base URL by @emmadesilva in #1890
- [2.x] Improve the blog post feed component by @emmadesilva in #1893
- [2.x] Add a
Feature::fromName()enum helper by @emmadesilva in #1895 - [2.x] Support specifying features in the YAML configuration by @emmadesilva in #1896
- [2.x] Update the build service to group together dynamic pages by @emmadesilva in #1897
- [2.x] Update the
Markdown::rendermethod to always use the smart Markdown service by @emmadesilva in #1900 - [2.x] Improved dynamic Markdown links by @emmadesilva in #1901
- [2.x] Dynamic Markdown links by @emmadesilva in #1590
- [2.x] Remove HydeFront version and CDN URL configuration options by @emmadesilva in #1909
- [2.x] Simplify public asset service...
HydePHP v2 Release Candidate Four
What's Changed
- Bump postcss from 8.5.3 to 8.5.6 by @dependabot[bot] in #2252
- Update browserslist database by @github-actions[bot] in #2256
- Bump postcss from 8.5.3 to 8.5.6 in /packages/hyde by @dependabot[bot] in #2251
- Bump tailwindcss from 4.1.7 to 4.1.11 by @dependabot[bot] in #2253
- [2.x] Upgrade monorepo to use Pest 3 and remove Psalm by @emmadesilva in #2270
- Bump prettier from 3.5.3 to 3.6.2 by @dependabot[bot] in #2258
- Bump prettier from 3.5.3 to 3.6.2 in /packages/hyde by @dependabot[bot] in #2259
- Bump actions/download-artifact from 4 to 5 by @dependabot[bot] in #2260
- Bump @tailwindcss/vite from 4.1.7 to 4.1.12 by @dependabot[bot] in #2268
- Bump @tailwindcss/vite from 4.1.11 to 4.1.12 in /packages/hyde by @dependabot[bot] in #2269
- Bump actions/checkout from 4 to 5 by @dependabot[bot] in #2263
- Bump vite from 6.3.5 to 7.1.3 by @dependabot[bot] in #2272
- Bump vite from 6.3.5 to 7.1.3 in /packages/hyde by @dependabot[bot] in #2271
- [2.x] Improve Vite running detection on Windows by @emmadesilva in #2294
- [2.x] Add a
Filesystem::ensureParentDirectoryExistsmethod by @emmadesilva in #2293 - Merge Tailwind Dependabot changes by @emmadesilva in #2295
- Bump vite from 7.1.3 to 7.1.7 by @dependabot[bot] in #2291
- Bump vite from 7.1.3 to 7.1.7 in /packages/hyde by @dependabot[bot] in #2292
- Bump actions/setup-node from 4 to 5 by @dependabot[bot] in #2280
- Bump actions/github-script from 7 to 8 by @dependabot[bot] in #2281
- Merge Dependabot updates by @emmadesilva in #2297
- [2.x] Move the serve command to the realtime compiler package by @emmadesilva in #2298
- [2.x] Improve handling when running Vite without node modules by @emmadesilva in #2299
- [2.x] Support "excerpt" as alias for "description" in blog posts by @emmadesilva in #2300
- [2.x] Add namespaced function for the title helper by @emmadesilva in #2301
- Update package-lock.json by @emmadesilva in #2303
- Update Laravel Herd documentation by @emmadesilva in #2304
- Compile TailwindCSS for production by @emmadesilva in #2305
- [2.x] Add documentation sync workflow by @emmadesilva in #2306
- Bump actions/checkout from 4 to 5 by @dependabot[bot] in #2307
- Bump hyde-vite-plugin from 1.0.0-RC.4 to 1.0.0-RC.5 in /packages/hyde by @dependabot[bot] in #2309
- Bump hyde-vite-plugin to 1.0.0-RC.5 by @emmadesilva in #2310
- Bump @tailwindcss/typography from 0.5.16 to 0.5.19 in /packages/hyde by @dependabot[bot] in #2308
- [2.x] Rename --run-vite flag to --vite in the build command by @emmadesilva in #2311
- [2.x] Remove --run-prettier flag from the build command by @emmadesilva in #2312
- [2.x] Remove experimental annotations from codebase by @emmadesilva in #2313
- [2.x] Normalize @ and & in makeSlug helper by @emmadesilva in #2314
- [2.x] Rename docs.sidebar_group_labels to docs.sidebar.labels by @emmadesilva in #2315
- [2.x] Final release text cleanup by @emmadesilva in #2316
- Finalise HydePHP v2 release notes by @emmadesilva in #2296
- HydePHP v2 Release Candidate Four by @emmadesilva in #2317
Full Changelog: v2.0.0-RC.3...v2.0.0-RC.4
HydePHP v2 Release Candidate Three
What's Changed
- Forward DateString method calls to DateTime instances by @Cyberking99 in #2235
- [2.x] Fix rebuild command showing the wrong console output by @nats-afs in #2240
New Contributors
- @Cyberking99 made their first contribution in #2235
Full Changelog: v2.0.0-RC.2...v2.0.0-RC.3
HydePHP v2 Release Candidate Two
What's Changed
- Use HydePHP v2 packages in the split Hyde package by @caendesilva in #2230
Full Changelog: v2.0.0-RC.1...v2.0.0-RC.2
HydePHP v2 Release Candidate One
At long last, this is the first release candidate for HydePHP v2.0. Please stay tuned for the official release which will contain the finalized changeset and release notes with upgrade guide. However, for those who are curious - feel free to start testing this right now!
What's Changed
- [2.x] Set up HydePHP v2 by @caendesilva in #1497
- [2.x] Rewrite documentation search page internals to be based on dynamic pages instead of a build task by @caendesilva in #1498
- [2.x] Refactor media asset transferring to be in a build task by @caendesilva in #1536
- [2.x] Add conditional semantic documentation article rendering by @caendesilva in #1566
- [2.x] Remove unused internal
DocumentationSearchPage::generate()method by @caendesilva in #1569 - [2.x] Change default DocumentationPage group to be
nullinstead of'other'by @caendesilva in #1572 - [2.x] Remove duplicate navigation item filtering by @caendesilva in #1573
- [2.x] Change NavItem class API to be fluent instead of readonly by @caendesilva in #1574
- [2.x] Improved navigation group label generation by @caendesilva in #1576
- [2.x] Simplify dropdown data handling by @caendesilva in #1577
- [2.x] Refactor navigation menu generators by @caendesilva in #1578
- [2.x] Merge menu generator actions into single class by @caendesilva in #1579
- [2.x] Split out base navigation menu class from main menu class by @caendesilva in #1580
- [2.x] Refactor navigation menu container bindings by @caendesilva in #1581
- [2.x] Breaking: Change configuration option
docs.sidebar_ordertodocs.sidebar.orderby @caendesilva in #1583 - [2.x] Breaking: Change configuration option
docs.table_of_contentstodocs.sidebar.table_of_contentsby @caendesilva in #1584 - [2.x] Support setting sidebar labels and visibility in docs config by @caendesilva in #1586
- [2.x] Massively simplify sidebar footer text handling by @caendesilva in #1594
- [2.x] Refactor sidebar data handling by @caendesilva in #1587
- [2.x] Always place navigation menu items in dropdowns when set in front matter by @caendesilva in #1597
- [2.x] Create positioning priority constants in the navigation menu class by @caendesilva in #1598
- [2.x] Refactor NavItem class by @caendesilva in #1599
- [2.x] Rename NavItem fields to normalize its API by @caendesilva in #1600
- [2.x] Extract back NavItem class for dropdowns by @caendesilva in #1601
- [2.x] Create HTML tests for the navigation layouts by @caendesilva in #1605
- [2.x] Clean up navigation view markup by @caendesilva in #1606
- [2.x] Normalize navigation HTML ID naming by @caendesilva in #1622
- [2.x] Expand abbreviated navigation item class names by @caendesilva in #1625
- [2.x] Restructure navigation item class design to use composition over inheritance by @caendesilva in #1626
- [2.x] Simplify navigation item group state handling to be deterministic by @caendesilva in #1632
- [2.x] Create new navigation destination class to replace external routes by @caendesilva in #1636
- [2.x] Simplify the navigation items class by @caendesilva in #1637
- [2.x] Create better fallbacks when not supplying a navigation item label by @caendesilva in #1638
- [2.x] Remove the group property from the navigation item class by @caendesilva in #1639
- [2.x] Remove the
NavigationElementcontract by @caendesilva in #1640 - [2.x] Extract trait for shared code with navigation menu class by @caendesilva in #1630
- [2.x] Merge trait back into menu class and make navigation groups extend the menu class by @caendesilva in #1645
- [2.x] Simplify and normalize public navigation APIs by @caendesilva in #1642
- [2.x] Rewrite navigation internals by @caendesilva in #1568
- [2.x] Refactor features class to be a kernel singleton by @caendesilva in #1647
- [2.x] Refactor features class to simplify it and extract an enum by @caendesilva in #1649
- [2.x] Change default build task message to make it more concise by @caendesilva in #1659
- [2.x] Simplify the Feature enum class by @caendesilva in #1651
- [2.x] Clean up and refactor code by @caendesilva in #1665
- [2.x] Refactor filesystem helpers by @caendesilva in #1698
- [2.x] Honour front matter navigation groups set in front matter regardless of subdirectory setting by @caendesilva in #1704
- [2.x] Calling the
Include::path()method will no longer create the directory by @caendesilva in #1707 - [2.x] Support automatic navigation priorities by prefixing a number in filenames by @caendesilva in #1709
- [2.x] Improve the numerical filename priority prefix feature by @caendesilva in #1710
- [2.x] DataCollections improvements by @caendesilva in #1732
- [2.x] Includes facade improvements by @caendesilva in #1738
- [2.x] Update the
routehelper function to throw if the route does not exist by @caendesilva in #1741 - [2.x] Even smarter sitemap generation by @caendesilva in #1744
- [2x] Use a non-zero exit code 3 when skipping build tasks by @caendesilva in #1749
- [2.x] Remove the deprecated global
unslashfunction by @caendesilva in #1754 - [2.x] Remove the deprecated
BaseUrlNotSetExceptionclass by @caendesilva in #1760 - [2.x] Overhaul the blog post authors feature by @caendesilva in #1782
- [2.x] Add an invalid configuration exception class by @caendesilva in #1799
- [2.x] Update custom exception class to accept previous throwable by @caendesilva in #1800
- [2.x] Clean up author code by @caendesilva in #1819
- [2.x] Support setting extra attributes for navigation items by @caendesilva in #1824
- [2.x] Add a navigation config builder class by @caendesilva in #1827
- [2.x] Clean up the navigation documentation by @caendesilva in #1828
- [2.x] Clean up the navigation and sidebar documentation by @caendesilva in #1838
- [2.x] Move the sidebar documentation to the documentation pages page by @caendesilva in #1841
- [2.x] Unify the Navigation API by @caendesilva in #1818
- [2.x] Add booting and booted callbacks to the HydeExtension feature by @caendesilva in #1847
- [2.x] Fix realtime compiler search index serving by @caendesilva in #1878
- [2.x] Remove deprecated method
FeaturedImage::isRemote()by @caendesilva in #1883 - [2.x] Update blog posts to use
BlogPostingSchema.org type by @caendesilva in #1887 - [2.x] Add more rich markup data to blog post components by @caendesilva in #1888
- [2.x] Revert to throwing an exception when trying to get non-configured base URL by @caendesilva in #1890
- [2.x] Improve the blog post feed component by @caendesilva in #1893
- [2.x] Add a
Feature::fromName()enum helper by @caendesilva in #1895 - [2.x] Support specifying features in the YAML configuration by @caendesilva in #1896
- [2.x] Update the build service to group together dynamic pages by @caendesilva in #1897
- [2.x] Update the
Markdown::rendermethod to always use the smart Markdown service by @caendesilva in #1900 - [2.x] Improved dynamic Markdown links by @caendesilva in https://github.com/hydephp/develop/p...
v1.8.0 - 2025-05-17
1.8.0 - 2025-05-17
Added
- Updated the
HydeKernelarray representation to include the Hyde version in #1786 - Registered the
cache:clearcommand to make it easier to clear the cache in #1881 - Added a new
Hyperlinks::isRemote()helper method to check if a URL is remote in #1882 - All page types now support the
descriptionfront matter field (used in page metadata) in #1884 - Added a new
Filesystem::findFiles()method to find files in a directory in #2064 - Added
webpto the list of default media extensions in hydephp/framework#663 - Added a new slug generation helper to improve internationalization support in #2070
Changed
- Changed the
Hydefacade to use a@mixinannotation instead of single method annotations in #1919 - Updated the
Serializabletrait to provide a default automatictoArraymethod in #1791 - Updated the
PostAuthorclass'snameproperty to fall back to theusernameproperty if thenameproperty is not set in #1794 - Removed the nullable type hint from the
PostAuthorclass'snameproperty as it is now always set in #1794 - Improved the accessibility of the heading permalinks feature in #1803
- The
torchlight:installcommand is now hidden from the command list as it's already installed in #1879 - Updated the home page fallback link in the 404 template to lead to the site root in #1880 (fixes #1781)
- Normalized remote URL checks so that protocol relative URLs
//are consistently considered to be remote in all places in #1882 (fixes #1788) - Page slugs are now generated using our automatically internationalizing slug generator to transliterate input to ASCII in #2070
- Replaced internal usages of glob functions with our improved file finder in #2064
- Updated to HydeFront v3.4 in #1803
- Realtime Compiler: Virtual routes are now managed through the service container in #1858
- Realtime Compiler: Improved the dashboard layout in #1866
- Realtime Compiler: Shorten the realtime compiler server start message from "Press Ctrl+C to stop" to "Use Ctrl+C to stop" to better fit 80 column terminals in #2017
Deprecated
- The
PostAuthor::getName()method is now deprecated and will be removed in v2. (use$author->nameinstead) in #1794 - Deprecated the
FeaturedImage::isRemote()method in favor of the newHyperlinks::isRemote()method in #1882 - Deprecated the
Hyde::mediaLink()method in favor of theHyde::asset()method in #1993
Fixed
- Fixed Tailwind content paths for nested Blade pages in #2042
- Added missing collection key types in Hyde facade method annotations in #1784
- Fixed heading permalinks button text showing in Google Search previews #1801 in #1803
- Fixed routing issues with nested 404 pages where an index page does not exist #1781 in #1880
- Fixed URL metadata for blog posts not using customized post output directories in #1889
- Fixed lacking support for logographic slug generation hydephp/hyde#269 in #2070
- Improved printed documentation views in #2005
- Fixed "BuildService finding non-existent files to copy in Debian" hydephp/framework#662 in #2064
- Fixed "Undefined constant
Hyde\Foundation\Kernel\GLOB_BRACE" hydephp/hyde#270 in #2064 - Realtime Compiler: Updated the exception handler to match HTTP exception codes when sending error responses in #1853
- Realtime Compiler: Improved routing for nested index pages in #1852
- Realtime Compiler: Improved the dashboard #1866 fixing hydephp/realtime-compiler#22 and hydephp/realtime-compiler#29
- Realtime Compiler: Fixed support for serving media assets in subdirectories hydephp/realtime-compiler#26 in #1872
What's Changed in the Monorepo
- Internal: Update the updating documentation by @caendesilva in #1780
- Add missing collection key types in the Hyde facade method annotations by @caendesilva in #1784
- Internal: Add unit testing helper method by @caendesilva in #1785
- Update the
HydeKernelarray representation to include the Hyde version by @caendesilva in #1786 - Framework version v1.7.1 by @caendesilva in #1787
- Internal: Clean up test code by @caendesilva in #1789
- Update the
Serializabletrait to provide a default automatictoArraymethod by @caendesilva in #1791 - Extract helper method for automatic serialization by @caendesilva in #1793
- [1.x] Update the post author class to prepare for the v2 overhaul by @caendesilva in #1794
- Internal: Replace deprecated method usage by @caendesilva in #1795
- Internal: Improve test static analysis and improve tests by @caendesilva in #1796
- Internal: Improve the monorepo HydeFront versioning process by @caendesilva in #1804
- Bump prettier from 2.6.0 to 3.3.2 in /packages/hyde by @dependabot in #1805
- Bump sass from 1.50.0 to 1.77.6 in /packages/hydefront by @dependabot in #1806
- Improve the documentation heading permalinks feature by @caendesilva in #1803
- Internal: Update HydeFront package information by @caendesilva in #1807
- Internal: Improve testing helpers by @caendesilva in #1808
- Framework version v1.7.2 by @caendesilva in #1809
- Internal: Update the monorepo release command to create the remote branches by @caendesilva in #1810
- Internal: Update monorepo PhpStorm configuration files by @caendesilva in #1811
- Clean up the documentation by @caendesilva in #1812
- Internal: Add a linting feature to the documentation generator script by @caendesilva in #1813
- Internal: Version control the monorepo pages configuration by @caendesilva in #1814
- Internal: Build an experimental Git history graph by @caendesilva in #1815
- Internal: Clean up the history graph generator script by @caendesilva in #1816
- Internal: Refactor HydeStan code by @caendesilva in #1822
- Normalize documented link in code documentation by @caendesilva in #1820
- Add new HydeStan rules and resolve code style issues by @caendesilva in #1823
- Internal: Update view testing helpers by @caendesilva in #1825
- Bump sass from 1.77.6 to 1.77.7 in /packages/hydefront by @dependabot in #1826
- Fix article excerpt indentation by @caendesilva in #1829
- Bump sass from 1.77.7 to 1.77.8 in /packages/hydefront by @dependabot in #1830
- Internal: Adding an experimental config converter command to the monorepo by @caendesilva in #1833
- Remove extra space from command signature by @caendesilva in #1832
- Internal: Update internal config converter command by @caendesilva in #1834
- Internal: Update documentation Markdown formatting by @caendesilva in #1836
- Internal: Refactor the Markdown formatter script with Claude by @caendesilva in #1837
- Proof and format the documentation by @caendesilva in #1839
- Update documentation to use APA ti...
v1.7.0 - 2024-07-05
1.7.0 - 2024-07-05
Added
- Added support for using HTML comments to create Markdown code block filepath labels in #1693
- Added a config option to disable the theme toggle buttons to automatically use browser settings in #1697
- You can now specify which path to open when using the
--openoption in the serve command in #1694 - Added a
--format=jsonoption to theroute:listcommand in #1724
Changed
- When a navigation group is set in front matter, it will now be used regardless of the subdirectory configuration in #1703 (fixes #1515)
- Use late static bindings to support overriding data collections file finding in #1717 (fixes #1716)
- Method
Hyde::hasSiteUrl()now returns false if the site URL is for localhost in #1726 - Method
Hyde::url()will now return a relative URL instead of throwing an exception when supplied a path even if the site URL is not set in #1726 - Updated the
.env.examplefile to contain more details on the site URL setting's usages in #1746 - Added a version prefix to the sitemap's generator attribute in #1767
- Setting a site name in the Yaml config file will now influence all configuration values where this is used, unless already set, in #1770 and #1773
Deprecated
- Deprecated the global
unslash()function, replaced with the existing namespaced\Hyde\unslash()function in #1753 - Deprecated the
BaseUrlNotSetExceptionclass in #1759
Removed
- The Git version is no longer displayed in the debug screen and dashboard in #1756
Fixed
- Fixed explicitly set front matter navigation group behavior being dependent on subdirectory configuration, fixing #1515 in #1703
- Fixed DataCollections file finding method not being able to be overridden #1716 in #1717
- Fixed PHP warning when trying to parse a Markdown file with just front matter without body #1705 in #1728
- Fixed #1748 by normalizing generator version prefixes in #1767
- Yaml data files no longer need to start with triple dashes to be parsed by DataCollections in #1733
- Updated the Hyde URL helper to not modify already qualified URLs in #1757
Extra information
This release contains changes to how HydePHP behaves when a site URL is not set by the user.
These changes are made to reduce the chance of the default localhost value showing up in production environments.
Most notably, HydePHP now considers that default site URL localhost to mean that a site URL is not set, as the user has not set it.
This means that things like automatic canonical URLs will not be added, as Hyde won't know how to make them without a site URL.
The previous behaviour was that Hyde used localhost in canonical URLs, which is never useful in production environments.
For this reason, we felt it worth it to make this change in a minor release, as it has a such large benefit for sites.
You can read more about the details and design decisions of this change in the following pull request #1726.
What's Changed in the Monorepo
What's Changed
- Internal: Update Dependabot configuration to update GitHub Actions by @caendesilva in #1669
- Internal: Update workflows to better handle running in forks by @caendesilva in #1675
- Bump codecov/codecov-action from 3 to 4 by @dependabot in #1670
- Bump actions/download-artifact from 2 to 4 by @dependabot in #1671
- Bump actions/cache from 3 to 4 by @dependabot in #1672
- Bump actions/checkout from 2 to 4 by @dependabot in #1673
- Bump actions/upload-artifact from 1 to 4 by @dependabot in #1674
- Add unit test for naming conventions by @caendesilva in #1676
- Fix command description wording by @caendesilva in #1677
- Move internal helper classes to new internal support namespace by @caendesilva in #1678
- Refactor to massively simplify internal route list helper classes by @caendesilva in #1679
- Bump github/codeql-action from 2 to 3 by @dependabot in #1680
- Bump actions/setup-node from 3 to 4 by @dependabot in #1681
- Internal: Update Dependabot configuration to update NPM packages by @caendesilva in #1682
- Bump postcss from 8.4.31 to 8.4.38 by @dependabot in #1683
- Bump prettier from 2.6.0 to 3.2.5 by @dependabot in #1684
- Bump @tailwindcss/typography from 0.5.2 to 0.5.12 by @dependabot in #1685
- Bump tailwindcss from 3.1.0 to 3.4.3 by @dependabot in #1686
- Bump autoprefixer from 10.4.7 to 10.4.19 by @dependabot in #1687
- Internal: Update Tailwind compiler to force push build by @caendesilva in #1688
- Clean up internal helper code by @caendesilva in #1690
- Add custom filepath label support for HTML comments by @caendesilva in #1693
- Update realtime compiler open flag to support specifying the page to open by @caendesilva in #1694
- Bump @tailwindcss/typography from 0.5.12 to 0.5.13 by @dependabot in #1695
- Internal: Update Tailwind compiler to force push builds to the target branch by @caendesilva in #1696
- Add a config option to disable theme toggle buttons to automatically use browser settings by @caendesilva in #1697
- [1.x] Refactor filesystem helpers by @caendesilva in #1699
- .gitattributes: substitute CRLF only in text files by @ydalton in #1700
- Merge changes from downstream repository by @caendesilva in #1701
- Fix gitattributes normalization across all packages by @caendesilva in #1702
- [1.x] Honour front matter navigation groups set in front matter regardless of subdirectory setting by @caendesilva in #1703
- Internal: Update file testing helpers by @caendesilva in #1708
- Bump prettier from 3.2.5 to 3.3.0 by @dependabot in #1711
- Use late static bindings to support overriding data collections file finding by @caendesilva in #1717
- Bump prettier from 3.3.0 to 3.3.1 by @dependabot in #1713
- Bump tailwindcss from 3.4.3 to 3.4.4 by @dependabot in #1714
- Bump prettier from 3.3.1 to 3.3.2 by @dependabot in #1721
- Bump braces from 3.0.2 to 3.0.3 by @dependabot in #1723
- Bump braces from 3.0.2 to 3.0.3 in /packages/hydefront by @dependabot in #1722
- Add a JSON output format option to the route list command by @caendesilva in #1724
- Clean up and refactor route list command code by @caendesilva in #1725
- Code cleanup and refactors by @caendesilva in #1727
- Fix undefined array key exception for empty Markdown pages by @caendesilva in #1728
- Improve behaviour when a site URL is not explicitly set by @caendesilva in #1726
- Bump ws from 8.8.1 to 8.17.1 by @dependabot in #1729
- [1.x] DataCollections improvements by @caendesilva in #1733
- Internal: Update test fixtures to use "class" instead of "className" by @caendesilva in #1739
- Update site URL documentation to contain more details on its usages by @caendesilva in #1746
- Internal: Extract testing helpers and refactor tests by @caendesilva in #1747
- Internal: Add statistics output for analysed expressions by @caendesilva in #1750
- Minor code ...
v1.6.0 - 2024-04-17
1.6.0 - 2024-04-17
Added
- Added a
@headstack to thehead.blade.phpcomponent in #1567 - Added a
Hyde::route()helper to theHydefacade in #1591 - Added new global helper functions (
asset(),route(),url()) in #1592 - Added a new
Featureenum to improve theFeaturesfacade in #1650 - Added a helper to
->skip()build tasks in #1656
Changed
- The
featuresarray in theconfig/hyde.phpconfiguration file is now an array ofFeatureenums in #1650 - Sitemap generation will now be skipped if a base URL is not set, as Google now will not index sitemaps without a base URL in #1660
- Updated the debug command to print the binary path when running in a standalone Phar in #1667
Deprecated
- Deprecated the static
Featuresflag methods used in the configuration files in #1650 which will be removed in HydePHP v2.0
Fixed
- Fixed a bug where the sitemap and RSS feed generator commands did not work when the
_site/directory was not present in #1654 - Fixed extra newlines being written to console for failing build tasks in #1661
- Markdown formatting will now be stripped when generating an automatic blog post description when none is set in #1662 (fixes #1634)
- Realtime Compiler: Fixed responsive dashboard table issue in #1595
Upgrade Path
In order to prepare your project for HydePHP v2.0, you should update your config/hyde.php configuration file to use the new Feature enum for the features array.
You can see the changes to make in your Hyde project by looking at the following pull request https://github.com/hydephp/hyde/pull/250/files
Your new config array should look like this:
// Make sure to import the new Feature enum at the top of the file
use Hyde\Enums\Feature;
// Then replace your enabled features with the new Feature enum cases
'features' => [
// Page Modules
Feature::HtmlPages,
Feature::MarkdownPosts,
Feature::BladePages,
Feature::MarkdownPages,
Feature::DocumentationPages,
// Frontend Features
Feature::Darkmode,
Feature::DocumentationSearch,
// Integrations
Feature::Torchlight,
],If you need more help, you can see detailed upgrade instructions with screenshots in the pull request #1650
What's Changed in the Monorepo
What's Changed
- Add a
@headstack to thehead.blade.phpcomponent by @caendesilva in #1567 - Refactor unit test to replace complex mock with inlined build loop by @caendesilva in #1570
- Remove global function imports from tests by @caendesilva in #1582
- Remove old smooth page scrolling config entry from documentation by @caendesilva in #1585
- Improved view testing by @caendesilva in #1588
- Improve and add more view tests by @caendesilva in #1589
- Add a
Hyde::route()helper method by @caendesilva in #1591 - Update internal documentation preview workflow by @caendesilva in #1593
- Improved helper functions by @caendesilva in #1592
- Make the dashboard table properly responsive by @caendesilva in #1595
- Improved view testing helper by @caendesilva in #1596
- Add more view tests for the navigation menu by @caendesilva in #1603
- Create additional view test method by @caendesilva in #1604
- Internal: Move testing helper classes to new helpers directory by @caendesilva in #1607
- Internal: Improve testing helpers by @caendesilva in #1608
- Internal: Improve and refactor testing helpers by @caendesilva in #1609
- Update internal monorepo tools by @caendesilva in #1611
- Bump follow-redirects from 1.15.4 to 1.15.6 by @dependabot in #1612
- Internal: Create workflow to label pull requests by @caendesilva in #1615
- Internal: Add example tests by @caendesilva in #1614
- Internal: Update labeling workflow to run on pull request state edits by @caendesilva in #1616
- Internal: Create new HTML testing framework by @caendesilva in #1613
- Internal: Move base testing classes to testing package by @caendesilva in #1617
- Internal: Normalize view testing helpers by @caendesilva in #1618
- Internal: Update code intelligence class parsing to evaluate Alpine classes by @caendesilva in #1619
- Update supported versions in package readmes by @caendesilva in #1620
- Designate HydePHP v1.x as LTS by @caendesilva in #1621
- Internal: Update pull request labeling workflow by @caendesilva in #1623
- Internal: Fix workflow formatting by @caendesilva in #1624
- Internal: Update continuous integration server integration by @caendesilva in #1627
- Internal: Update continuous integration server integrations to better handle forks by @caendesilva in #1629
- Bump webpack-dev-middleware from 5.3.3 to 5.3.4 by @dependabot in #1628
- Bump Composer dependencies by @caendesilva in #1631
- Internal: Update PhpStorm configuration files by @caendesilva in #1633
- Internal: Add testing helper to mock kernel features by @caendesilva in #1641
- Bump express from 4.18.1 to 4.19.2 by @dependabot in #1644
- Internal: Update Pest configuration to use unit test case by @caendesilva in #1648
- Introduce a new Feature enum to improve the Features facade by @caendesilva in #1650
- Internal: Improve test suite by @caendesilva in #1653
- Improve the codebase using the new Feature enum by @caendesilva in #1652
- Fix issues with the sitemap and RSS feed generator commands by @caendesilva in #1654
- Internal: Add build task unit test by @caendesilva in #1658
- Add a skip feature to build tasks by @caendesilva in #1656
- Fix extra newline being written for failing build tasks by @caendesilva in #1661
- Skip sitemap generation when there is no valid base URL by @caendesilva in #1660
- Internal: Clean up test code by @caendesilva in #1655
- Internal: Try to fix Codecov by @caendesilva in #1657
- Clean up HTML and Blade files by @caendesilva in #1610
- Strip Markdown from automatic blog post descriptions by @caendesilva in #1662
- Internal: Setup Pest type coverage plugin for the monorepo by @caendesilva in #1664
- Clean up and refactor code by @caendesilva in #1663
- Update debug command to print binary path when running in the Phar standalone by @caendesilva in #1667
- HydePHP v1.6.0 - 2024-04-17 by @caendesilva in #1668
Full Changelog: v1.5.0...v1.6.0
v1.5.0 - 2024-02-13
1.5.0 - 2024-02-13
Improved Patch Release Strategy
This release experiments some changes into how releases are handled to clarify the patch versioning of distributed packages compared to the monorepo source versioning.
In short: We are now experimenting with rolling patch releases, where patches are released as soon as they're ready, leading to faster rollout of bugfixes.
This means that the patch version discrepancy between the monorepo and the distributed packages will be increased, but hopefully the end results will still be clearer,
thanks to the second related change: Prefixing the subpackage changes in this changelog with the package name. If there is no prefix, the change applies to the core package or the monorepo.
All this to say, please keep in mind that when the monorepo gets a new minor version, the prefixed changes may already have been released as patches in their respective packages.
Added
- Added the existing
media_extensionsoption to thehydeconfiguration file in #1531 - Added configuration options to add custom HTML to the
<head>and<script>sections in #1542 - Added support for adding custom HTML to the
<head>and<script>sections using HTML includes in #1554 - Added an
htmlhelper to theIncludesfacade in #1552
Changed
- Renamed local template variable
$documentto$articleto better match the usage in #1506 - Updated semantic documentation article component to support existing variables in #1506
- Updated the Markdown to plain text converter to trim whitespace in #1561
- HydeFront: Changed
<code>styling to display as inline instead of inline-block in #1525 - Realtime Compiler: Add strict type declarations in #1555
- Bumped Realtime Compiler version to v3.3 in #1562
- Internal: Renamed snake case test methods to camel case in #1556
Deprecated
- Deprecated the
BuildService::transferMediaAssets()method in #1533, as it will be moved into a build task in v2.0.
Fixed
- Fixed icons not being considered as images by dashboard viewer in #1512
- HydeFront: Fixed bug where heading permalink buttons were included in text represented output in #1519
- HydeFront: Fix visual overflow bug in inline code blocks within blockquotes hydephp/hydefront#65 in #1525
- Realtime Compiler: Fixes visual dashboard bugs hydephp/realtime-compiler#23 and hydephp/realtime-compiler#24 in #1528
What's Changed in the Monorepo
- Improve support for running HydePHP through the Phar archive by @caendesilva in #1491
- Shorten path printed to console when using the dashboard to create a page by @caendesilva in #1492
- Fix wrong section title in dashboard by @caendesilva in #1493
- Add info banners when dashboard content is empty by @caendesilva in #1494
- Framework version v1.4.1 by @caendesilva in #1495
- Format and normalize files by @caendesilva in #1501
- Clean up and normalize class description comments by @caendesilva in #1502
- Normalize console command descriptions by @caendesilva in #1503
- Framework version v1.4.2 by @caendesilva in #1505
- Improve the semantic documentation article Blade view by @caendesilva in #1506
- Bump follow-redirects from 1.15.1 to 1.15.4 by @dependabot in #1510
- Apply fixes from StyleCI by @caendesilva in #1511
- Fix icons not being considered as images by dashboard viewer by @caendesilva in #1512
- Update documentation introduction by @caendesilva in #1513
- Update the Hyde UI Kit resources for initial release by @caendesilva in #1518
- Make heading permalink hashes hidden when not hovered by @caendesilva in #1519
- Update UI kit documentation by @caendesilva in #1520
- Document links to the new first party extensions by @caendesilva in #1521
- Compile HydeFront assets for production by @caendesilva in #1522
- Remove inline block display from inline code elements by @caendesilva in #1525
- Compile HydeFront assets for production by @caendesilva in #1526
- Bump HydeFront version by @caendesilva in #1527
- Add UI Kit documentation by @caendesilva in #1524
- Visual dashboard bugfixes by @caendesilva in #1528
- Framework version v1.4.3 by @caendesilva in #1529
- Update version compatibility documentation by @caendesilva in #1530
- Add media extensions option to default config by @caendesilva in #1531
- Document advanced configuration options by @caendesilva in #1532
- Clean up documentation by @caendesilva in #1537
- Deprecate
BuildService::transferMediaAssets()by @caendesilva in #1533 - Add dedicated navigation documentation page by @caendesilva in #1540
- Internal: Update monorepo documentation previews to use the new server by @caendesilva in #1543
- Minor documentation and workflow cleanups by @caendesilva in #1544
- Compile TailwindCSS for production by @caendesilva in #1547
- HydeFront v3.3.4 by @caendesilva in #1548
- Add internal documentation intelligence tools by @caendesilva in #1545
- Documentation improvements by @caendesilva in #1546
- Add configuration options to add HTML to the head and scripts sections by @caendesilva in #1542
- Document support features by @caendesilva in #1549
- Document stock includes by @caendesilva in #1550
- Update includes facade to use trait instead of repeated logic by @caendesilva in #1551
- Add a new
Includes::html()helper by @caendesilva in #1552 - Simplify the includes facade documentation by @caendesilva in #1553
- Support using HTML includes to set head and script HTML by @caendesilva in #1554
- Clean up code by @caendesilva in #1555
- Rename snake case test methods to be camel case by @caendesilva in #1556
- Update internal documentation intelligence tools by @caendesilva in #1557
- Normalize documentation heading level formatting by @caendesilva in #1558
- Normalize documentation formatting by @caendesilva in #1559
- Update Markdown to plaintext formatter to trim whitespace by @caendesilva in #1561
- Format and normalize files by @caendesilva in #1560
- Bump Realtime Compiler version to v3.3 by @caendesilva in #1562
- HydePHP v1.5.0 - 2024-02-13 by @caendesilva in #1563
Full Changelog: v1.4.0...v1.5.0
v1.4.0 - 2023-12-11
1.4.0 - 2023-12-11
Added
- Adds a new fancy output for the realtime compiler serve command in #1444
- Added support for dot notation in the Yaml configuration files in #1478
- Added a config option to customize automatic sidebar navigation group names in #1481
- Added a new
hyde serve --openoption to automatically open the site in the browser in #1483 - Added a new Live Edit feature to the realtime compiler in #1458
Changed
- The
docs.sidebar.footerconfig option now accepts a Markdown string to replace the default footer in #1477 - Links in the
sitemap.xmlfile are now relative when a site URL is not set, instead of using the default localhost URL in #1479 - Improves the portability of the realtime compiler to better support running through the standalone executable in #1488
- Bumps realtime compiler version to v3.2 in #1489
- Support both route keys and identifiers for specifying sidebar order in #1432
- Updated sitemap generator to use relative links instead of localhost when missing site URL in #1479
Removed
- Removed unhelpful boilerplate from the
hyde/hydepackage.jsonin #1436
Fixed
Internal
- Internal: Only inject custom app config location when missing from parent in #1485
- Internal: Remove experimental Phar support from internal configuration loader in #1485
What's Changed in the Monorepo
- Update internal monorepo release command by @caendesilva in #1422
- Update Framework readme contribution section to match the Hyde package by @caendesilva in #1423
- Update internal releaser to use constant as version base for patch releases by @caendesilva in #1424
- Framework version v1.3.2 by @caendesilva in #1425
- Internal: Upgrade Laravel Dusk driver by @caendesilva in #1429
- Unslash documentation page home route name by @caendesilva in #1427
- Migrate PHPUnit configuration by @caendesilva in #1428
- Framework version v1.3.3 by @caendesilva in #1430
- Improve navigation priority discovery to allow sidebars and main navigation to support both list and keyed config syntax by @caendesilva in #1431
- Bump PHP setup action for test runners by @caendesilva in #1433
- Support both route keys and identifiers for specifying sidebar order by @caendesilva in #1432
- Update realtime compiler dashboard to block unsafe requests by @caendesilva in #1434
- Update internal testing scripts by @caendesilva in #1435
- Sync back with downstream repositories by @caendesilva in #1437
- Use dynamic PHP setup action version for test runners by @caendesilva in #1438
- Update monorepo readme to use the develop branch for package test badges by @caendesilva in #1439
- Update internal testing scripts by @caendesilva in #1440
- Create slim package.json by @caendesilva in #1436
- Handle old todo markers in codebase by @caendesilva in #1442
- Implement process output test by @caendesilva in #1445
- Realtime compiler dashboard improvements by @caendesilva in #1443
- Fancy serve command by @caendesilva in #1444
- Add dashboard hook to interact with fancy serve command output by @caendesilva in #1446
- Refactor console output internals by @caendesilva in #1447
- Minor dashboard internals cleanup by @caendesilva in #1448
- Fancy serve command cleanup by @caendesilva in #1449
- Pass through settings to the realtime compiler by @caendesilva in #1450
- Update navigation documentation by @caendesilva in #1451
- Fix command extending wrong base class by @caendesilva in #1453
- Add realtime compiler dashboard CSRF protection by @caendesilva in #1454
- Realtime compiler code cleanup by @caendesilva in #1455
- Update node dependencies and monorepo node package handling by @caendesilva in #1456
- Compile TailwindCSS for production by @caendesilva in #1457
- Refactor internal dashboard header handling by @caendesilva in #1459
- Minor internal realtime compiler code cleanup by @caendesilva in #1460
- Revamp extensions documentation by @caendesilva in #1461
- Change internal realtime compiler console context handling by @caendesilva in #1462
- Legacy realtime compiler beta version reaches end of life 2023-12-31 by @caendesilva in #1463
- Add a live edit feature to the realtime compiler by @caendesilva in #1458
- Document new realtime compiler features by @caendesilva in #1464
- Document the Extensions API by @caendesilva in #1465
- Update live edit feature to protect against overwriting modified content by @caendesilva in #1466
- Split out extensions documentation by @caendesilva in #1468
- Add documentation index page to the sidebar when it's the only page by @caendesilva in #1472
- Merge downstream Framework patch version by @caendesilva in #1473
- Update configuration option for the documentation sidebar footer to allow custom Markdown to be specified by @caendesilva in #1477
- Document issue #1475 by @caendesilva in #1476
- Expand dot notation when merging Yaml configuration by @caendesilva in #1478
- Update sitemap to use relative links instead of localhost when missing site URL by @caendesilva in #1479
- Internal: Upgrade monorepo Codecov action to v3 by @caendesilva in #1480
- Add config option to customize automatic sidebar navigation group names by @caendesilva in #1481
- Internal: Update extensions documentation by @caendesilva in #1482
- Document automatic subdirectory navigation dropdown configuration by @caendesilva in #1484
- Refactor internal configuration loader and remove experimental Phar support by @caendesilva in #1485
- Add option to open site in the browser when starting the realtime compiler by @caendesilva in #1483
- Update readme security section to include advisories link by @caendesilva in #1486
- Improve portability of the realtime compiler by @caendesilva in #1488
- Bump realtime compiler version to v3.2 by @caendesilva in #1489
- HydePHP v1.4.0 - 2023-12-11 by @caendesilva in #1490
Full Changelog: v1.3.0...v1.4.0