manifest

The manifest scope defines pipeline metadata that is useful when publishing or running your pipeline.

manifest.author

Deprecated in version 24.10

Use manifest.contributors instead.

Project author name (use a comma to separate multiple names).

manifest.contributors

Added in version 24.10

List of project contributors. Should be a list of maps.

The following fields are supported in the contributor map:

name

The contributor name.

affiliation

The contributor affiliated organization.

email

The contributor email address.

github

The contributor GitHub URL.

contribution

List of contribution types, each element can be one of 'author', 'maintainer', or 'contributor'.

orcid

The contributor ORCID URL.

manifest.defaultBranch

Deprecated in version 26.04

Nextflow can automatically detect the default branch when using a remote pipeline.

Git repository default branch (default: master).

manifest.description

Free text describing the workflow project.

manifest.diagram

Added in version 26.10

Project workflow diagram location (Relative path or URL).

manifest.docsUrl

Project documentation URL.

manifest.doi

Project related publication DOI identifier.

manifest.gitmodules

Controls whether git sub-modules should be cloned with the main repository.

Can be either a boolean value, a list of submodule names, or a comma-separated string of submodule names.

manifest.homePage

Project home page URL.

manifest.icon

Project related icon location (Relative path or URL).

manifest.license

Project license.

manifest.mainScript

Project main script (default: main.nf).

manifest.name

Project short name.

manifest.nextflowVersion

Nextflow version required to run the pipeline.

Nextflow compares the current version against this requirement and prints a warning when it is not met. With the ! prefix, Nextflow stops execution instead.

This setting does not download or select a Nextflow version. The version that runs is determined by how Nextflow was installed or launched. Use NXF_VER to select a version at the command line, or the Nextflow version selector when launching from Seqera Platform.

The following version requirements are supported:

manifest.nextflowVersion = '1.2.3'        // exact match
manifest.nextflowVersion = '1.2+'         // 1.2 or later (excluding 2 and later)
manifest.nextflowVersion = '>=1.2'        // 1.2 or later
manifest.nextflowVersion = '>=1.2, <=1.5' // any version in the 1.2 .. 1.5 range
manifest.nextflowVersion = '!>=1.2'       // stop execution if the version does not match

See VersionNumber for details.

manifest.organization

Project organization.

manifest.recurseSubmodules

Pull submodules recursively from the Git repository.

manifest.version

Project version number.