Skip to content

Commit

Permalink
Include new manifest fields in the documentation
Browse files Browse the repository at this point in the history
Signed-off-by: jorgee <[email protected]>
  • Loading branch information
jorgee committed Sep 19, 2024
1 parent 6aefbac commit 9f9ef3f
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.iconUrl`
: Project related icon location (Relative path or URL).

`manifest.license`
: Workflow 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.

Expand All @@ -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.

Expand Down

0 comments on commit 9f9ef3f

Please sign in to comment.