Manual include or exclude specific files in template
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 322
- Forks
- 255
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 5
Description
We should consider the ability to include or exclude specific files via the .nf-core.yml here. Not clear how we should do this yet but it could be a specific key for the .nf-core.yml:
exclude:
- .github/workflows/fix-linting.yml
- .github/workflows/clean-up.yml
include:
- .github/workflows/ci.yml
This would override the broad categories by the wizard. It could be bypassed when using the TUI for now, consider it an advanced feature.
Originally posted by @adamrtalbot in https://github.com/nf-core/tools/pull/3084#discussion_r1697227173
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 template wizard reads .nf-core.yml and applies its broad file categories, including how the TUI currently handles them. Define the configuration behavior for include and exclude lists, including their precedence and TUI bypass, then verify that selected files are generated or omitted as specified.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100