Skip to content
Snippets Groups Projects
Unverified Commit b949cd00 authored by Stuart Robson's avatar Stuart Robson Committed by GitHub
Browse files

Merge pull request #340 from visual-framework/docs/component-versioning

Add notes on versioning of components
parents 8aad42f3 6f321e9d
No related branches found
No related tags found
No related merge requests found
Pipeline #16538 passed with stage
in 2 minutes and 10 seconds
......@@ -13,6 +13,8 @@ You can [view all releases in the GitHub release log](https://github.com/visual-
Releases of vf-core are done monthly on the last Thursday in each month.
## Versioning
As not all users of the Visual Framework will be able to update to the very latest and we do not wish to hold others back, we are using a [semantic versioning](https://semver.org/) style of releases.
| Major release | Minor release | Note |
......
---
title: Component versioning
---
[Looking for notes on versioning of vf-core]({{ '/docs/changelog' | path }})?
The versioning of components is self-contained and distinct from the version number of `vf-core`
Example: if `vf-component`@`2.2.0` has a breaking change, it would be updated to
`vf-component`@`3.0.0`. That new version number does not affect compatibility with with `vf-core`@`2.x`.
Other notes and tips on components:
- should use a [semantic versioning](https://semver.org/) 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.2` requires `vf-component-y`@`^8.1.0`
- can live as part of the `vf-core` [monorepo](https://gomonorepo.org/)
- Interested in adding a component? [Get in touch](https://embl-vf.slack.com/messages)
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment