Skip to content

0.3.0

Choose a tag to compare

@michaelmayer2 michaelmayer2 released this 23 Oct 08:05
· 5 commits to main since this release
4134eff

Headless Nextflow runs: the Nextflow driver itself can run as a Workbench Job, so a pipeline keeps running without a session. The Positron Nextflow extension 0.2.0 uses this. The plugin's submit/status/kill contract with the launcher is unchanged.

Added

  • submit --env KEY[=VALUE]: sets environment variables for the job. It's repeatable, and a bare KEY passes the variable through from your environment.
  • submit --workdir: sets the job's working directory.
  • kill --graceful: stops a job with SIGTERM instead of SIGKILL, so a Nextflow driver can cancel its tasks before it exits.
  • examples/headless/:
    • driver.sh, a driver script for headless runs.
    • check-session-credentials.sh, which checks that a job's own Workbench credentials keep working after the session that submitted it has stopped.
  • Docs: "Headless runs" in docs/usage.md.

Verified on Posit Workbench (Kubernetes)

  • Interactive runs: the session's credentials reach the launcher CLI.
  • Headless runs started from a Positron session: the driver job submits its tasks with credentials of its own. Those credentials keep working after the session stops, for 7 days.
  • Not yet tested: headless runs submitted through the Workbench API with WORKBENCH_API_KEY.

Changed

  • The plugin and launcher are now 0.3.0. Update plugins { id 'nf-workbench@0.3.0' } in pipeline configs.

Install

Plugin:

mkdir -p ~/.nextflow/plugins/nf-workbench-0.3.0
unzip nf-workbench-0.3.0.zip -d ~/.nextflow/plugins/nf-workbench-0.3.0

Launcher: it needs posit-sdk from the workbench branch of michaelmayer2/posit-sdk-py.

uv tool install --force --with "posit-sdk @ git+https://github.com/michaelmayer2/posit-sdk-py@workbench" \
  https://github.com/sol-eng/posit-sdk-nextflow/releases/download/v0.3.0/posit_workbench_nf_launcher-0.3.0-py3-none-any.whl

If an older launcher comes earlier on your PATH, for example from an activated launcher/.venv, it is found first. Check with type -a posit-workbench-nf-launcher.

See CHANGELOG.md.