diff --git a/docs/config.md b/docs/config.md index d88aba4269..55de60428a 100644 --- a/docs/config.md +++ b/docs/config.md @@ -1237,15 +1237,27 @@ The following settings are available: `manifest.description` : Free text describing the workflow project. +`manifest.docsUrl` +: Project documentation URL. + `manifest.doi` : Project related publication DOI identifier. `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.maintainer` +: Project maintainer name (use a comma to separate multiple names). + `manifest.name` : Project short name. @@ -1262,6 +1274,9 @@ The following settings are available: manifest.nextflowVersion = '!>=1.2' // with ! prefix, stop execution if current version does not match required version. ``` +`manifest.organisation` +: Project organisation + `manifest.recurseSubmodules` : Pull submodules recursively from the Git repository. diff --git a/modules/nextflow/src/main/groovy/nextflow/config/Manifest.groovy b/modules/nextflow/src/main/groovy/nextflow/config/Manifest.groovy index ad06fa0a49..f8592294e2 100644 --- a/modules/nextflow/src/main/groovy/nextflow/config/Manifest.groovy +++ b/modules/nextflow/src/main/groovy/nextflow/config/Manifest.groovy @@ -98,8 +98,28 @@ class Manifest { target.doi } + String getDocsUrl() { + target.docsUrl + } + + String getIcon(){ + target.icon + } + + String getMaintainer(){ + target.maintainer + } + + String getOrganisation(){ + target.organisation + } + + String getLicense(){ + target.license + } + Map toMap() { - final result = new HashMap(10) + final result = new HashMap(15) result.author = getAuthor() result.defaultBranch = getDefaultBranch() result.description = getDescription() @@ -109,6 +129,11 @@ class Manifest { result.version = getVersion() result.nextflowVersion = getNextflowVersion() result.doi = getDoi() + result.docsUrl = getDocsUrl() + result.icon = getIcon() + result.maintainer = getMaintainer() + result.organisation = getOrganisation() + result.license = getLicense() return result } } diff --git a/modules/nextflow/src/test/groovy/nextflow/config/ManifestTest.groovy b/modules/nextflow/src/test/groovy/nextflow/config/ManifestTest.groovy index d189b28f28..8fb398590b 100644 --- a/modules/nextflow/src/test/groovy/nextflow/config/ManifestTest.groovy +++ b/modules/nextflow/src/test/groovy/nextflow/config/ManifestTest.groovy @@ -26,8 +26,9 @@ class ManifestTest extends Specification { def 'should check manifest object' () { given: - def MAN = [author: 'pablo', nextflowVersion: '1.2.3', name: 'foo'] - + def MAN = [author: 'pablo', nextflowVersion: '1.2.3', name: 'foo', + maintainer: 'john', organisation: 'My Organisation', icon: 'icon.png', + docsUrl: 'https://docs.io', license: 'Apache v2'] when: def manifest = new Manifest(MAN) then: @@ -35,6 +36,11 @@ class ManifestTest extends Specification { author == 'pablo' nextflowVersion == '1.2.3' name == 'foo' + maintainer == 'john' + organisation == 'My Organisation' + icon == 'icon.png' + docsUrl == 'https://docs.io' + license == 'Apache v2' } } @@ -55,6 +61,11 @@ class ManifestTest extends Specification { nextflowVersion == null version == null name == null + maintainer == null + docsUrl == null + organisation == null + icon == null + license == null } }