nf-core lint fails on bug report when pipeline is unbranded
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 322
- Forks
- 255
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 5
Description
Description of the bug
Running nf-core lint on a pipeline which is unbranded but uses github hosting fails with
files_unchanged: .github/ISSUE_TEMPLATE/bug_report.yml does not match the template
This is because a particular section of the bug report is removed when running create unbranded but not accounted for in the lint.
I would have happily created my pipeline without it since I actually host on GitLab but if you don't use github hosting during the create you lose almost all git related fileseg .gitignore and the CONTRIBUTING.md which lives under .github.
As a corollary to this issue, perhaps it would be possible to narrow disabling GitHub hosting to only remove issue templates? Or to move the contirbuting docs to the docs folder?
Command used and terminal output
No response
System information
nf-core/tools 2.7.2
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
Reproduce the failure with nf-core lint on an unbranded pipeline using GitHub hosting, then compare the generated .github/ISSUE_TEMPLATE/bug_report.yml with the lint expectation. Trace the create and lint entry points that handle the bug report template. Done means an unbranded pipeline no longer reports this template as unchanged incorrectly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100