While it may seem odd at first, not all components are on the same major version. You'll find that you might use vf-button@1.2.3 with vf-card@2.2.2.
vf-core@2.1.2might usevf-button@1.0.1andvf-component-x@8.2.1vf-button@1.0.1might requirevf-link@3.0.1or newer
We recommend using the latest version of each component, you can update your components with yarn upgrade-interactive --latest.
Here's what the usage of semantic versioning means for the Visual Framework:
- All components are compatible with with
vf-core, some components may require a minimum version ofvf-core - If
vf-corehas a breaking change it will be updated a full version (v2.0→v3.0), and components may also need to be updated - Yarn is used for package management
- Minimum versions of dependencies are specified in project's
package.json - Components also use semantic versioning
- Components may also require minimum versions of other components
Think of it like your computer's operating system, just because you update Windows 10 doesn't always mean your Firefox version needs to change.
Where to get the latest version
Versions of vf-core and components are published to npm; see the Visual Framework building guide.
What does this mean for component support?
Components should specify if they only support specific versions of vf-core or require other specific versions of patterns.
Other notes and tips on components:
- should use a semantic versioning style of releases
- must work with
vf-core v2.x, but a component may specify a minimum required minor version of vf-core - may indicate any required versions of peer-components in your component's README.md.
vf-component-x@2.1.2requiresvf-component-y@^8.1.0
- can live as part of the
vf-coremonorepo- Interested in adding a component? Get in touch or make an issue
- read more about component versioning in this issue
Release notes
Release notes are published to the Updates blog and include notes from the associated CHANGELOG.md files in the release.
Where's version 1 of vf-core?
Where's version 1.x, you ask? That's the EMBL-EBI specific Visual Framework from where this concept originated, and evolved.
Test releases
Testing releases will be identified in their tag, a la: v2.0-alpha.1, where -alpha.1 is the tag. -alpha, -beta and -rc are tag suffixes.