nextflow-io / nextflow-io/nextflow

Use `-resume` with run names in addition to session IDs

Open
#4,837 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

stale
Dominant language
Groovy
Stars
3.5k
Forks
811
Avg merge
2d 11h
Merged PRs (30d)
61

Description

New feature

It should be possible to also use run ID -names with the -resume flag when a user wants to refer to a specific previous pipeline run to resume.

Usage scenario

Currently is possible to specifically tell Nextflow to resume a specific run with a particular session-id.

However session-ids are only normally found by running nextflow log, something that a typical user will rarely if ever use, or even be aware of.

It is much more common knowledge to refer to runs via the <adjective>_<surname> run IDs, which are displayed at the top of each run.

Thus it would make more intuitive sense for users to be able to use that with -resume.

Suggest implementation

Presumably would require updating the flag parsing, and then where that session ID gets referred to (I can't find exactly where the validated session ID gets read, sorry)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in modules/nextflow/src/main/groovy/nextflow/cli/Launcher.groovy at the flag-parsing section around lines 215-222, then trace where the validated session ID is read for -resume. Done means -resume accepts the displayed adjective_surname run name and resumes that specific previous pipeline run, while existing session-ID behavior remains available.

Written by the indexing model from the issue text.

Assessment

Tech stack
groovy
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.