Release Notes
This indicates how and when we create our releases
DartStream Release Notes
Overview
Our release notes track the framework's evolution, highlighting new features, improvements, and important changes.
Release Philosophy
Our development approach focuses on:
Simplicity: Keeping the framework intuitive and easy to use
Performance: Optimizing for speed and resource efficiency
Flexibility: Providing adaptable solutions for diverse project requirements
Version Tracking
DartStream and its other first-party packages follow Semantic Versioning. Major framework releases are released every year (~Q1), while minor and patch releases may be released as often as every week. Minor and patch releases should never contain breaking changes.
When referencing the DartStream framework or its components from your application or package, you should always use a version constraint such as ^11.0, since major releases of DartStream do include breaking changes. However, we strive to always ensure you may update to a new major release in one day or less.
Versioning System
We follow semantic versioning (MAJOR.MINOR.PATCH)
Major versions may include breaking changes
Minor versions introduce new features without breaking existing functionality
Patch versions are reserved for bug fixes and minor improvements
What to Expect in Release Notes
Each release note will provide:
New Features: Detailed descriptions of added capabilities
Improvements: Enhancements to existing functionalities
Bug Fixes: Resolved issues and their implications
Breaking Changes: Any modifications that might require code updates
Migration Guides: Step-by-step instructions for updating to the new version
Supported Dart Versions
Minimum Dart SDK: 3.0.0
Recommended Dart SDK: Latest stable release
Support and Community
GitHub Repository: [DartStream GitHub Link]
Documentation: Comprehensive guides and API references
Community Forum: [Link to community discussion platform]
Contribution Guidelines
We welcome contributions from the community:
Report issues on our GitHub repository
Submit pull requests for bug fixes or features
Follow our contribution guidelines for smooth collaboration
Stay Informed
Subscribe to Release Notifications
Follow our blog for in-depth articles and framework updates
Join our community channels for real-time discussions
Legal and Licensing
DartStream is open-source software, released under [Specify License, e.g., MIT License].
Release Notes
Versioning Scheme
DartStream and its other first-party packages follow Semantic Versioning. Major framework releases are released every year (~Q1), while minor and patch releases may be released as often as every week. Minor and patch releases should never contain breaking changes.
When referencing the DartStream framework or its components from your application or package, you should always use a version constraint such as ^11.0, since major releases of DartStream do include breaking changes. However, we strive to always ensure you may update to a new major release in one day or less.
Named Arguments
Named arguments are not covered by DartStream's backwards compatibility guidelines. We may choose to rename function arguments when necessary in order to improve the DartStream codebase. Therefore, using named arguments when calling DartStream methods should be done cautiously and with the understanding that the parameter names may change in the future.
Support Policy
For all DartStream releases, bug fixes are provided for 9 months and security fixes are provided for 12 months/1 year. For all additional libraries not owned by DartStream, only the latest major release receives bug fixes. In addition, please review the SDK versions supported by DartStream.
.0.0.1-Prelease
3.3.0+
April 15th, 2024
September 1, 2024
February 6th, 2024
TBD
TBD
TBD
TBD
End of life Security fixes only (*) Supported PHP versions
DartStream 11
DartStream 11 continues the improvements made in DartStream 10.x by introducing a streamlined application structure, per-second rate limiting, health routing, graceful encryption key rotation, queue testing improvements, Resend mail transport, Prompt validator integration, new Artisan commands, and more. In addition, DartStream Reverb, a first-party, scalable WebSocket server has been introduced to provide robust real-time capabilities to your applications.
PHP 8.2
DartStream 11.x requires a minimum PHP version of 8.2.
Last updated