nf-core/tools API documentation
Automated documentation for nf-core/tools (1.9
)
nf_core.bump_version
Bumps the version number in all appropriate files for a nf-core pipeline.
nf_core.bump_version.bump_nextflow_version(lint_obj, new_version)
Bumps the required Nextflow version number of a pipeline.
- Parameters:
- lint_obj (nf_core.lint.PipelineLint) – A PipelineLint object that holds information about the pipeline contents and build files.
- new_version (str) – The new version tag for the required Nextflow version.
nf_core.bump_version.bump_pipeline_version(lint_obj, new_version)
Bumps a pipeline version number.
- Parameters:
- lint_obj (nf_core.lint.PipelineLint) – A PipelineLint object that holds information about the pipeline contents and build files.
- new_version (str) – The new version tag for the pipeline. Semantic versioning only.
nf_core.bump_version.update_file_version(filename, lint_obj, pattern, newstr, allow_multiple=False)
Updates the version number in a requested file.
- Parameters:
- filename (str) – File to scan.
- lint_obj (nf_core.lint.PipelineLint) – A PipelineLint object that holds information about the pipeline contents and build files.
- pattern (str) – Regex pattern to apply.
- newstr (str) – The replaced string.
- allow_multiple (bool) – Replace all pattern hits, not only the first. Defaults to False.
- Raises: SyntaxError**,** if the version number cannot be found. –