Skip to content

Latest commit

 

History

History
53 lines (37 loc) · 3.71 KB

RELEASE_NOTES.md

File metadata and controls

53 lines (37 loc) · 3.71 KB

[Unreleased] - YYYY-MM-DD

About

Keep an Unreleased section at the top to track upcoming changes.

This serves two purposes:

  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 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 --open option in the serve command in #1694
  • Added a --format=json option to the route:list command 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.example file to contain more details on the site URL setting's usages in #1746

Deprecated

  • Deprecated the global unslash() function, replaced with the existing namespaced \Hyde\unslash() function in #1753

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
  • 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

Security

  • in case of vulnerabilities.

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.