Release Notes
Introduction
Welcome to the world of Dreamfork - In this section, we'll explore the versioning strategy adopted by Dreamfork and understand the process of updating your projects as new versions of the framework are released. Familiarizing yourself with the versioning conventions and upgrade procedures is crucial to staying current with the latest features, improvements, and fixes in Dreamfork. Whether you're initiating a new project or maintaining an existing one, this guide will provide insights into seamlessly navigating through framework updates. Let's dive into the details of version management and project upgrades within the Dreamfork ecosystem.
Versioning Approach
The framework follows Semantic Versioning (SemVer) to clearly identify changes in each version. According to SemVer, the version number has the format MAJOR.MINOR.PATCH:
-
MAJOR:Incremented when making incompatible API changes or significant architectural shifts that require manual migration. -
MINOR:Introduces substantial new features or large functional updates in a backward-compatible manner. -
PATCH:Focuses on bug fixes, security updates, and minor backward-compatible enhancements or small feature additions (such as new helper methods or driver improvements).
This approach allows the framework to evolve quickly and deliver useful features without waiting for larger release cycles, while still guaranteeing that your application will not break during a patch update.
Update Process
At present, Dreamfork doesn't have a dedicated update mechanism akin to Composer packages. However, fear not - the process of updating the framework to the latest version is generally straightforward and reversible. Even in major versions, there's a high likelihood that over 90% of your application will remain compatible, and necessary adjustments will be minimal.
To update your project to the current version of the framework, follow these steps:
Visit Changelog
Head to the Changelog section, where each update is briefly described, including the implementation steps for your project.
Review Changes
Familiarize yourself with the changes introduced in the latest version, paying attention to any backward compatibility considerations.
Backup Your Project
Before proceeding with the update, create a backup of your project to safeguard against any unforeseen issues. This way if any critical issues arise, you can roll back to the previous version.
Testing
Test your project thoroughly after the update to ensure that all functionalities work as expected.
While Dreamfork strives to make updates seamless, always exercise caution and carefully review the Changelog for specific guidance on implementing updates in your project.