Add linting to prevent using oras protocol
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 322
- Forks
- 255
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 5
Description
Description of feature
the oras protocol has a few downsides in the context of nextflow and nf-core (see: https://nf-co.re/blog/2024/seqera-containers-part-2#singularity-oras-or-https ):
- Shared cache Nextflow options such as
$NXF_SINGULARITY_CACHEDIRand$NXF_SINGULARITY_LIBRARYDIRare not used - Singularity must be installed when downloading images for offline use
oras://is only supported by recent versions of Singularity / Apptainer
Therefore, we decided to keep using https for the time being. There are several nf-core/modules and local modules that use the oras protocol at the moment.
It would be helpful to have linting to prevent the usage of oras protocol for the moment.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Search the repository and the linked nf-core code search for oras:// occurrences, then locate the existing linting entry point and its tests. Done means linting reports or rejects oras:// usage while continuing to permit https references.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100