Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
V
vf-core-mirror
Manage
Activity
Members
Code
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Operate
Environments
Terraform modules
Analyze
Contributor analytics
CI/CD analytics
Repository analytics
Insights
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
embl.org
vf-core-mirror
Commits
6f321e9d
Commit
6f321e9d
authored
6 years ago
by
Ken Hawkins
Browse files
Options
Downloads
Patches
Plain Diff
Update versioning.njk
parent
3352555b
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Pipeline
#16038
passed with stage
in 2 minutes and 5 seconds
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/guidelines/versioning.njk
+10
-9
10 additions, 9 deletions
docs/guidelines/versioning.njk
with
10 additions
and
9 deletions
docs/guidelines/versioning.njk
+
10
−
9
View file @
6f321e9d
...
...
@@ -4,16 +4,17 @@ title: Component versioning
[Looking for notes on versioning of vf-core]({{ '/docs/changelog' | path }})?
The
re are two principles to note:
The
versioning of components is self-contained and distinct from the version number of `vf-core`
- Components use a [semantic versioning](https://semver.org/) style of releases
- Versioning of component 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`.
That is, if a `vf-pattern@2.2.0` has a breaking change, it would be updated to
`vf-pattern@v3.0.0` and still be compatible with `vf-core@2.x`.
Other notes and tips on components:
All patterns should be designed to work with vf-core 2.x, but the may specify a
- 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.
You should indicate any required versions of vf-core or peer-components in your
component's README.md.
- 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)
This diff is collapsed.
Click to expand it.
Preview
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment