nf-core / nf-core/tools

Capture `.nf-core.yml` errors and give a useful message

Open
#3,573 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
Python
Stars
322
Forks
255
Avg merge
2d 3h
Merged PRs (30d)
5

Description

Description of the bug

Context on Slack: https://nfcore.slack.com/archives/CE5LG7WMB/p1747295666065149

TODO:

  • Capture the traceback and print a useful error message
  • Print the key that throws the error
  • Link to the lint error docs
Command used and terminal output
nf-core modules update


AssertionError: Config file '.nf-core.yml' is invalid
lint: Input should be a valid boolean
input: ['README.md', 'main.nf']
System information

No response

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

Reproduce the failure with nf-core modules update and the invalid .nf-core.yml shown in the report, then trace the configuration-validation error path. Done means the traceback is captured, the failing key is identified, and the message links to the nf-core lint error documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.