From 9b29ace9b6e0092df4d2499d1ce1077f008a619d Mon Sep 17 00:00:00 2001 From: Caen De Silva Date: Wed, 7 Feb 2024 16:19:27 +0100 Subject: [PATCH 1/2] Update updating-hyde.md --- docs/digging-deeper/updating-hyde.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/digging-deeper/updating-hyde.md b/docs/digging-deeper/updating-hyde.md index d2595c90186..baf3aef5fff 100644 --- a/docs/digging-deeper/updating-hyde.md +++ b/docs/digging-deeper/updating-hyde.md @@ -13,6 +13,24 @@ This guide will help you update your HydePHP project to the latest version. When updating an existing installation, first ensure that you have a backup of your project in case anything goes wrong. The recommended way to do this is to use Git as that allows you to smoothly roll back any changes. +## Version compatibility + +HydePHP follows [semantic versioning](https://semver.org/), so you can expect that minor and patch releases will be backwards compatible. +Only major releases may introduce breaking changes, all of which are thoroughly documented in the accompanying release notes. + +New features and bug fixes are added in minor and patch releases, so it is recommended to keep your project up to date. + +### Side effects and ensuring a smooth update + +Please note that due to the indicate nature of software, there is a possibility that an update contains side effects, +hence why version controlling your site is helpful when updating versions as you can roll back changes. It can also +be helpful to version control the compiled HTML, so you can view a diff of the changes. Be sure to test your site +can be built and that it looks as expected after updating before deploying the changes to your live site. + +We of course have extensive tests in place run on each single code commit to ensure all code is functional, +however when fixing bugs it is possible that for example a bug fix may change an edge-case that some users may be relying on. + +Obligatory related XKCD: [https://xkcd.com/1172/](https://xkcd.com/1172/) ## Methods From 8fcee2c53e43a8e3eaeab2c92ca4c726ceb429ac Mon Sep 17 00:00:00 2001 From: Caen De Silva Date: Wed, 7 Feb 2024 16:32:09 +0100 Subject: [PATCH 2/2] Update updating-hyde.md --- docs/digging-deeper/updating-hyde.md | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/docs/digging-deeper/updating-hyde.md b/docs/digging-deeper/updating-hyde.md index baf3aef5fff..0acb3d6ce11 100644 --- a/docs/digging-deeper/updating-hyde.md +++ b/docs/digging-deeper/updating-hyde.md @@ -22,15 +22,15 @@ New features and bug fixes are added in minor and patch releases, so it is recom ### Side effects and ensuring a smooth update -Please note that due to the indicate nature of software, there is a possibility that an update contains side effects, +Please note that due to the intricate nature of software, there is a possibility that an update contains side effects, hence why version controlling your site is helpful when updating versions as you can roll back changes. It can also -be helpful to version control the compiled HTML, so you can view a diff of the changes. Be sure to test your site +be helpful to version control the compiled HTML, so you can view a diff of the changes. Be sure to test that your site can be built and that it looks as expected after updating before deploying the changes to your live site. -We of course have extensive tests in place run on each single code commit to ensure all code is functional, -however when fixing bugs it is possible that for example a bug fix may change an edge-case that some users may be relying on. +We of course have extensive tests in place run on each single code commit to ensure all code is functional, however, +it is still possible that some edge cases slip through. This means that a bug fix may impact an edge case that you depend on. -Obligatory related XKCD: [https://xkcd.com/1172/](https://xkcd.com/1172/) +Obligatory related XKCD: [https://xkcd.com/1172](https://xkcd.com/1172) ## Methods @@ -43,6 +43,17 @@ update your project. If you are not using Git, you can still update your project Regardless of the method you use, make sure you follow the [post-update instructions](#post-update-instructions) at the end. +### Updating just the Framework + +If you just want to update the framework patch version, you can do so by running the following command: + +```bash +composer update hyde/framework +``` + +While the same can still be done for minor versions, it's best to also update your project scaffolding and resources to +ensure that everything is up to date, for which you should use the methods below. + ### Using Git First, make sure you have a remote set up for the base project repository. @@ -135,3 +146,5 @@ Finally, you can rebuild your site. ```bash php hyde build ``` + +Now, you should browse your site files to ensure things are still looking as expected.