nextflow-io / nextflow-io/nextflow

Allow config scope aliases (e.g. objectStorage for aws)

Open
#7,387 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

New feature

Support alternative names for a config scope. Add objectStorage (or something else, v open to ideas) as an alias for aws, so S3-compatible storage can be configured without AWS-specific naming.

Use case

Configuring S3-compatible object stores (Cloudflare R2, MinIO, Backblaze, etc.) currently requires an aws {} scope, which is confusing when no AWS is involved. objectStorage {} reads naturally while reusing the existing S3 config and client.

Suggested implementation

  • New @ScopeAlias annotation in nextflow.config.spec, alongside @ScopeName.
  • Resolve aliases in config validation (ConfigValidator) and spec generation (PluginSpec) so aliased scopes validate and appear in docs.
  • Resolve at runtime in AwsConfig (canonical name wins if both set).
  • Annotate AwsConfig with @ScopeAlias("objectStorage").

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 by locating the nextflow.config.spec package and the ConfigValidator, PluginSpec, and AwsConfig entry points named in the issue. Trace how @ScopeName values are validated, documented, and read at runtime. Done means an @ScopeAlias can be declared, objectStorage is accepted and documented as an alias for aws, and aws takes precedence when both scopes are configured.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, groovy
Domain
cloud
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.