Introduction
The Digital Framework users a release strategy that is strictly followed to allow users to manage their project upgrades without any unexpected breaking changes. These fall into 3 version numbers separated by periods (.), MAJOR.MINOR.PATCH. Each number represents a series of changes separated by the impact it will have on a project. MAJOR releases are full changes to the API, MINOR releases are changes just to a single component and PATCH releases are changes throughout the project but are fully compatible with that MINOR release.
Versioning
Given a version number MAJOR.MINOR.PATCH, increment the:
- MAJOR version when a project wide, incompatible API change, update or fix,
- MINOR version when a single component breaking change, update or addition that affects only one single component,
- PATCH version when a backwards compatible bug fix that effects any part of the project but is fully compatible.
This will help you to decide how to take releases from us and effort involved, each release will come with full release notes to provide more detail on any changes.
Support
The Digital Framework supports the current latest version for any fixes, updates and additions.
Governance
The Framework is governed by a group of maintainers who will create new releases for all versions. The Framework will be kept up to date with any changes made within the Digital Guidelines. To stay brand compliant with the latest brand guidelines, it is recommended that a user keeps up to date with the latest current release.
Each version will come with a change log detailing everything that has changed in that release, allowing any planned upgrades from any project to encounter no unexpected breaking changes.
NPM ranges
It is recommended that you pin your release dependency to prevent any automatic updates, this can be done by removing the NPM range operator and having the specific version number you currently want to use. Find out more information about NPM Ranges >