Allow aliasing of git remotes with short names
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
To install a component from another git remote, you have to specify a long path in each nf-core command, e.g.:
nf-core subworkflows --git-remote https://github.com/sanger-tol/nf-core-modules.git install cram_map_illumina_hic
It would be nice to be able to store aliases for these - perhaps in a repos: section of .nf-core.yml? - so that you could write something like:
nf-core subworkflows --git-remote sanger-tol cram_map_illumina_hic
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
Start by tracing how the subworkflows commands handle --git-remote and how .nf-core.yml is loaded. Define the alias configuration and verify that a short name such as sanger-tol resolves to the corresponding remote when installing a component.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100