nf-core/tools API documentation
Automated documentation for nf-core/tools (1.13
)
version_consistency
PipelineLint.version_consistency()
Pipeline and container version number consistency.
Note
This test only runs when the --release
flag is set for nf-core lint
,
or $GITHUB_REF
is equal to master
.
This lint fetches the pipeline version number from three possible locations:
- The pipeline config,
manifest.version
- The docker container in the pipeline config,
process.container
- Some pipelines may not have this set on a pipeline level. If it is not found, it is ignored.
$GITHUB_REF
, if it looks like a release tag (refs/tags/<something>
)
The test then checks that:
- The container name has a tag specified (eg.
nfcore/pipeline:version
) - The pipeline version number is numeric (contains only numbers and dots)
- That the version numbers all match one another