Repository navigation
Add 26.10 migration notes #7739
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
0ea6a03
Add 26.10 migration notes
bentsherman fa2fc8e
Add breaking-change note for the weblog option
bentsherman 704abfe
Remove global cache section
bentsherman 0a54822
Update 26.10 migration notes for merged roadmap features
bentsherman c2c3224
Document samplesheet channel params in the static typing docs
bentsherman 0c01f37
Apply batched suggestions from review [ci fast]
bentsherman d3a909a
Point the static typing tutorial at the static-typing branch
bentsherman 6bc2757
Merge branch 'master' into docs-migration-notes-26-10
bentsherman File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,271 @@ | ||
| --- | ||
| title: Migrating to 26.10 | ||
| description: Review new features, breaking changes, and deprecations introduced in Nextflow 26.10. | ||
| --- | ||
|
|
||
| # Migrating to 26.10 | ||
|
|
||
| [Nextflow 26.10](https://github.com/nextflow-io/nextflow/releases/tag/v26.10.0) is scheduled to release in October 2026. | ||
|
|
||
| ## New features | ||
|
|
||
| ### Global cache | ||
|
|
||
| The global cache is a shared, content-addressable cache backed by cloud storage. It stores all task executions in a single work directory. Whereas `-resume` only reuses work from a previous run of the same pipeline, the global cache can reuse tasks across different runs. | ||
|
|
||
| The global cache is available through Seqera Platform. It supports AWS, Google Cloud, and Azure. | ||
|
|
||
| ### Static typing (out of preview) | ||
|
|
||
| [Static typing][static-typing], introduced in Nextflow 25.10 as a preview feature, has been brought out of preview. The syntax is unchanged since 26.04. This release brings type checking to the Nextflow CLI in addition to the language server. | ||
|
bentsherman marked this conversation as resolved.
Outdated
|
||
|
|
||
| `nextflow lint` reports type errors for any script that enables `nextflow.enable.types`. `nextflow run` warns when type errors are found, but does not fail the run. | ||
|
bentsherman marked this conversation as resolved.
Outdated
|
||
|
|
||
| The `nextflow.enable.types` flag is still required in every script that uses typed processes or typed workflows. | ||
|
bentsherman marked this conversation as resolved.
Outdated
|
||
|
|
||
| ### Workflow modules | ||
|
|
||
| The [module system][module-registry] now supports workflows as well as processes. | ||
|
|
||
| A module is a standalone process or a standalone workflow. A workflow module can be published to the Nextflow registry, installed, and included using the same commands and include syntax: | ||
|
bentsherman marked this conversation as resolved.
Outdated
|
||
|
|
||
| ```nextflow | ||
| // process module | ||
| include { BWA_MEM } from 'nf-core/bwa/mem' | ||
|
|
||
| // workflow module | ||
| include { FASTQ_ALIGN_STAR } from 'nf-core/fastq_align_star' | ||
| ``` | ||
|
|
||
| A workflow module can depend on other modules by declaring them in the module spec and including them in the module script. When a workflow module is installed, it vendors its dependencies under its own `modules` directory, so two workflows can depend on different versions of the same module without conflict. Edit the declared versions in `meta.yml` and re-vendor them with `module install -update-deps`. | ||
|
bentsherman marked this conversation as resolved.
Outdated
|
||
|
|
||
| A typed workflow module can be executed directly with `nextflow module run`: | ||
|
bentsherman marked this conversation as resolved.
Outdated
|
||
|
|
||
| ```bash | ||
| # create a typed workflow module | ||
| nextflow module create -kind Workflow acme/hello | ||
|
|
||
| # run the workflow module | ||
| nextflow module run acme/hello --greeting 'Hello world!' | ||
| ``` | ||
|
|
||
| Each `take:` input becomes a param of the same name, and its declared type determines how the value is read. A `Channel<E>` input takes a samplesheet path, which Nextflow loads as a channel of records, validating and converting each row against the element type. The samplesheet can be CSV, JSON, or YAML. Each `emit:` output is reported as a workflow output. | ||
|
bentsherman marked this conversation as resolved.
Outdated
|
||
|
|
||
| See [Modules][module-registry] and [Typed parameters][workflow-typed-params] for details. | ||
|
|
||
| ### Pipeline composition | ||
|
|
||
| A pipeline -- the `params` block, entry workflow, and `output` block of a script -- can be included and called like a named workflow. The `params` block acts as the `take:` section and the `output` block acts as the `emit:` section. This way, you can compose pipelines with regular dataflow logic. | ||
|
bentsherman marked this conversation as resolved.
Outdated
|
||
|
|
||
| Given a pipeline: | ||
|
|
||
| ```nextflow | ||
| // pipelines/rnaseq.nf | ||
| nextflow.enable.types = true | ||
|
|
||
| params { | ||
| input: Channel<Sample> | ||
| aligner: String = 'star_salmon' | ||
| fasta: Path | ||
| } | ||
|
|
||
| workflow { | ||
| // ... | ||
| } | ||
|
|
||
| output { | ||
| bams: Channel<Path> { path 'bams' } | ||
| multiqc: Path { path 'multiqc' } | ||
| } | ||
| ``` | ||
|
|
||
| Include it with the `workflow` keyword, name it with an alias, and call it with a record of params: | ||
|
|
||
| ```nextflow | ||
| // main.nf | ||
| nextflow.enable.types = true | ||
|
|
||
| include { workflow as RNASEQ } from './pipelines/rnaseq.nf' | ||
|
|
||
| workflow { | ||
| main: | ||
| rnaseq = RNASEQ(record( | ||
| input: channel.of( /* ... */ ), | ||
| fasta: file('index.fasta') | ||
| )) | ||
| rnaseq.bams.view() // Channel<Path> | ||
| rnaseq.multiqc.view() // Value<Path> | ||
| } | ||
| ``` | ||
|
|
||
| The `rnaseq.nf` pipeline can be run directly from the CLI or included like a named workflow. When included, the pipeline can consume a channel from an upstream pipeline, allowing it to process each item as soon as it is emitted. | ||
|
bentsherman marked this conversation as resolved.
Outdated
|
||
|
|
||
| Both the calling script and the included pipeline must enable static typing. | ||
|
|
||
| See [Pipeline composition][pipeline-composition] for details. | ||
|
|
||
| ### Agents (preview) | ||
|
|
||
| :::warning | ||
| Agents are a preview feature. Their syntax and behavior may change in future releases. | ||
| ::: | ||
|
|
||
| An agent is a process-shaped primitive that wraps an agent run. It declares inputs and outputs, renders a prompt, calls a language model, and emits the result: | ||
|
|
||
| ```groovy | ||
| // nextflow.config | ||
| agent.runner = 'pi' | ||
| ``` | ||
|
|
||
| ```nextflow | ||
| agent qa { | ||
| model 'openai/gpt-5-mini' | ||
| instruction 'You are a concise scientific assistant.' | ||
|
|
||
| input: | ||
| question: String | ||
|
|
||
| output: | ||
| answer: String | ||
|
|
||
| prompt: | ||
| """ | ||
| Answer briefly: ${question} | ||
| """ | ||
| } | ||
|
|
||
| workflow { | ||
| qa('What is FASTQ format?').view() | ||
| } | ||
| ``` | ||
|
|
||
| Each invocation runs as an ordinary Nextflow task with a work directory, retries, parallelism, caching, and lineage. Agents can be composed like processes with regular dataflow logic. | ||
|
bentsherman marked this conversation as resolved.
Outdated
|
||
|
|
||
| See [Agents][agent-page] for details. | ||
|
|
||
| ## Enhancements | ||
|
|
||
| ### Formatter preserves comments | ||
|
|
||
| The Nextflow formatter (`nextflow lint -format`) now preserves all comments in scripts and config files. Previously, comments were preserved only in specific locations, otherwise they were discarded. | ||
|
bentsherman marked this conversation as resolved.
Outdated
|
||
|
|
||
| ### `logfile` command | ||
|
|
||
| The new `logfile` command prints a `.nextflow.log` file, with optional level filtering and follow mode: | ||
|
|
||
| ```console | ||
| $ nextflow logfile kickass_rutherford -level ERROR | ||
| $ nextflow logfile last -f | ||
| ``` | ||
|
|
||
| The argument can be a run name, a session id or a unique prefix of one, the literal `last`, or a path to a log file. | ||
|
bentsherman marked this conversation as resolved.
Outdated
|
||
|
|
||
| See the [`logfile`][cli-logfile] command reference for details. | ||
|
|
||
| ### Accelerator directive for local executor | ||
|
|
||
| The local executor now allocates accelerators such as GPUs to tasks that request them with the `accelerator` directive. Set the environment variable for your accelerator type to declare which devices are available. See [Local executor][executor-local] for details. | ||
|
|
||
| ### Publish targets as a map | ||
|
|
||
| The `path` directive of a workflow output can return a map of source files to publish targets, which is equivalent to using the `>>` operator for each pair: | ||
|
bentsherman marked this conversation as resolved.
Outdated
|
||
|
|
||
| ```nextflow | ||
| output { | ||
| samples { | ||
| path { sample -> [ | ||
| (sample.fastq_1): "fastq/${sample.id}/", | ||
| (sample.fastq_2): "fastq/${sample.id}/" | ||
| ] } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| This way, the publish mapping can be extracted to a shared function, e.g., for pipeline composition. | ||
|
bentsherman marked this conversation as resolved.
Outdated
|
||
|
|
||
| See [Workflow outputs][workflow-output-def] for details. | ||
|
|
||
| ### Reports in the output directory | ||
|
|
||
| The DAG, execution report, timeline, and trace file can be saved to the workflow output directory instead of the launch directory, using the new `directory` option in each scope: | ||
|
bentsherman marked this conversation as resolved.
Outdated
|
||
|
|
||
| ```groovy | ||
| report { | ||
| enabled = true | ||
| directory = 'pipeline_info' | ||
| } | ||
| ``` | ||
|
|
||
| The path is resolved against `outputDir` and must be a relative path within it. | ||
|
|
||
| ### Configurable plugin registries | ||
|
|
||
| Nextflow resolves plugins from the public registry at `https://registry.nextflow.io` by default. Additional registries can now be configured through the `registry` config scope, and are tried in order. See [Plugin registry][plugin-registry] for details. | ||
|
bentsherman marked this conversation as resolved.
Outdated
|
||
|
|
||
| ### smolvm container engine | ||
|
|
||
| Nextflow can run tasks in [smolvm](https://github.com/smol-machines/smolvm) microVMs. See [smolvm][container-smolvm] for details. | ||
|
|
||
| ## Breaking changes | ||
|
|
||
| - The `-with-weblog` run option is no longer supported. Use the [nf-weblog](https://github.com/nextflow-io/nf-weblog) plugin instead. | ||
|
|
||
| - The `echo` process directive was removed. Use `debug` instead. | ||
|
|
||
| - The Kubernetes executor uses Jobs by default instead of Pods. Set [`k8s.computeResourceType`][config-k8s-computeResourceType] to `Pod` to keep the previous behavior. | ||
|
|
||
| - Nextflow console output is written to standard error instead of standard output, so that the output of commands such as `nextflow inspect` and `nextflow run -output-format json` is not mixed with log messages. | ||
|
bentsherman marked this conversation as resolved.
Outdated
|
||
|
|
||
| ### Cache-breaking changes | ||
|
|
||
| The hash function for `eval` commands was changed. This fixes a bug where tasks with `eval` outputs did not have a stable hash across runs. However, every process with an `eval` output will be re-executed on the first resume after upgrading. | ||
|
bentsherman marked this conversation as resolved.
Outdated
|
||
|
|
||
| ## Deprecations | ||
|
|
||
| - The `storeDir` process directive is deprecated. Use explicit workflow logic to reuse an intermediate output if it is present and compute it otherwise. See [`storeDir`][process-storeDir] for an example. | ||
|
|
||
| - The [`seqera.executor.autoLabels`][config-seqera-executor-autoLabels] config option is deprecated. Use [`tower.autoLabels`][config-tower-autoLabels] instead, which applies to every executor that supports the `resourceLabels` directive. | ||
|
|
||
| - Machine type selection for Google Batch through the Seqera Cloud Info service is deprecated, along with the [`NXF_CLOUDINFO_ENABLED`][env-vars-NXF_CLOUDINFO_ENABLED] environment variable. | ||
|
|
||
| ## Miscellaneous | ||
|
|
||
| - New config option: [`apptainer.resourceLimits`][config-apptainer-resourceLimits] | ||
| - New config option: [`azure.batch.pools.<name>.allowUnverifiedImages`][config-azure-batch-pools-allowUnverifiedImages] | ||
| - New config option: [`azure.batch.pools.<name>.virtualMachineImageId`][config-azure-batch-pools-virtualMachineImageId] | ||
| - New config option: [`dag.directory`][config-dag-directory] | ||
| - New config option: [`docker.cpuLimits`][config-docker-cpuLimits] | ||
| - New config option: [`manifest.diagram`][config-manifest-diagram] | ||
| - New config option: [`report.directory`][config-report-directory] | ||
| - New config option: [`seqera.executor.machineRequirement.onDemandCostRatio`][config-seqera-executor-onDemandCostRatio] | ||
| - New config option: [`singularity.resourceLimits`][config-singularity-resourceLimits] | ||
| - New config option: [`timeline.directory`][config-timeline-directory] | ||
| - New config option: [`tower.autoLabels`][config-tower-autoLabels] | ||
| - New config option: [`trace.directory`][config-trace-directory] | ||
|
|
||
| [agent-page]: ../agent | ||
| [cli-logfile]: ../reference/cli/logfile | ||
| [config-apptainer-resourceLimits]: ../reference/config/apptainer#apptainerresourcelimits | ||
| [config-azure-batch-pools-allowUnverifiedImages]: ../reference/config/azure#azurebatchpoolsnameallowunverifiedimages | ||
| [config-azure-batch-pools-virtualMachineImageId]: ../reference/config/azure#azurebatchpoolsnamevirtualmachineimageid | ||
| [config-dag-directory]: ../reference/config/dag#dagdirectory | ||
| [config-docker-cpuLimits]: ../reference/config/docker#dockercpulimits | ||
| [config-k8s-computeResourceType]: ../reference/config/k8s#k8scomputeresourcetype | ||
| [config-manifest-diagram]: ../reference/config/manifest#manifestdiagram | ||
| [config-report-directory]: ../reference/config/report#reportdirectory | ||
| [config-seqera-executor-autoLabels]: ../reference/config/seqera#seqeraexecutorautolabels | ||
| [config-seqera-executor-onDemandCostRatio]: ../reference/config/seqera#seqeraexecutormachinerequirementondemandcostratio | ||
| [config-singularity-resourceLimits]: ../reference/config/singularity#singularityresourcelimits | ||
| [config-timeline-directory]: ../reference/config/timeline#timelinedirectory | ||
| [config-tower-autoLabels]: ../reference/config/tower#towerautolabels | ||
| [config-trace-directory]: ../reference/config/trace#tracedirectory | ||
| [container-smolvm]: ../container/smolvm | ||
| [env-vars-NXF_CLOUDINFO_ENABLED]: ../reference/env-vars#nxf_cloudinfo_enabled | ||
| [executor-local]: ../executor/local#accelerators | ||
| [module-registry]: ../modules | ||
| [pipeline-composition]: ../workflow-typed#pipeline-composition | ||
| [plugin-registry]: ../plugins/plugin-registry#configuring-plugin-registries | ||
| [process-storeDir]: ../reference/process/directives/store-dir | ||
| [static-typing]: ../static-typing | ||
| [workflow-output-def]: ../workflow#outputs | ||
| [workflow-typed-params]: ../typed-parameters | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.