Skip to content

Commit 72ec5d9

Browse files
committed
update docs [ci skip]
Signed-off-by: Ben Sherman <bentshermann@gmail.com>
1 parent e677b26 commit 72ec5d9

File tree

1 file changed

+9
-18
lines changed

1 file changed

+9
-18
lines changed

docs/module.md

Lines changed: 9 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,7 @@ This feature requires the use of a local or shared file system for the pipeline
281281

282282
Modules are designed to be easy to share and re-use across different pipelines, which helps eliminate duplicate work and spread improvements throughout the community. There are several ways to share modules:
283283

284-
- Use the Nextflow module registry system (recommended, see below)
284+
- Use the Nextflow module registry (recommended, see below)
285285
- Simply copy the module files into your pipeline repository
286286
- Use [Git submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) to fetch modules from other Git repositories without maintaining a separate copy
287287
- Use the [nf-core](https://nf-co.re/tools#modules) CLI to install and update modules with a standard approach used by the nf-core community
@@ -293,7 +293,7 @@ Modules are designed to be easy to share and re-use across different pipelines,
293293
:::{versionadded} 26.04.0
294294
:::
295295

296-
Nextflow provides a module registry system that enables you to install, share, and manage reusable modules from centralized registries. This system provides version management, integrity checking, and seamless integration with the Nextflow DSL.
296+
Nextflow provides a module registry that enables you to install, share, and manage modules from centralized registries. This system provides version management, integrity checking, and seamless integration with the Nextflow DSL.
297297

298298
### Installing modules from a registry
299299

@@ -338,15 +338,6 @@ Module versions are tracked in `nextflow_spec.json` in your project directory:
338338
}
339339
```
340340

341-
You can also configure versions in `nextflow.config`:
342-
343-
```nextflow
344-
modules {
345-
'@nf-core/fastqc' = '1.0.0'
346-
'@nf-core/bwa-align' = '1.2.0'
347-
}
348-
```
349-
350341
When you run your workflow, Nextflow automatically installs or updates modules to match the specified versions.
351342

352343
### Discovering modules
@@ -364,7 +355,7 @@ List installed modules in your project:
364355
$ nextflow module list
365356
```
366357

367-
### Module integrity protection
358+
### Module checksum verification
368359

369360
Nextflow automatically verifies module integrity using checksums. If you modify a module locally, Nextflow will detect the change and prevent accidental overwrites:
370361

@@ -417,7 +408,7 @@ Your module directory must include:
417408

418409
Authentication is required for publishing and can be provided via the `NXF_REGISTRY_TOKEN` environment variable or in your configuration:
419410

420-
```nextflow
411+
```groovy
421412
registry {
422413
apiKey = 'YOUR_REGISTRY_TOKEN'
423414
}
@@ -433,7 +424,7 @@ $ nextflow module publish myorg/my-module -dry-run
433424

434425
By default, Nextflow uses the public registry at `https://registry.nextflow.io`. You can configure alternative or additional registries:
435426

436-
```nextflow
427+
```groovy
437428
registry {
438429
url = [
439430
'https://private.registry.myorg.com',
@@ -453,12 +444,12 @@ Registry modules follow a standard directory structure:
453444
modules/
454445
└── @scope/
455446
└── module-name/
447+
├── .checksum # Integrity checksum (generated automatically)
448+
├── README.md # Documentation (required for publishing)
456449
├── main.nf # Module entry point (required)
457450
├── meta.yaml # Module metadata (required for publishing)
458-
├── README.md # Documentation (required for publishing)
459-
├── .checksum # Integrity checksum (generated automatically)
460-
├── templates/ # Optional: process templates
461-
└── resources/ # Optional: module binaries and resources
451+
├── resources/ # Optional: module binaries and resources
452+
└── templates/ # Optional: process templates
462453
```
463454

464455
The `modules/` directory should be committed to your Git repository to ensure reproducibility.

0 commit comments

Comments
 (0)