adding `zenodo_release` to `nf-core.yml` does still produce a warning
Open
Nobody has claimed this yet.
bug
good-first-issue
- Dominant language
- Python
- Stars
- 322
- Forks
- 255
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 5
Description
Description of the bug
I tried to remove the triggers for different linting steps and wanted to get rid of readme:zenodo_release and did as it said here. I added the following to my nf-core.yml:
lint:
...
readme:
- nextflow_badge
- zenodo_release
However, when I run nf-core pipeline lint -d ./my-pipeline I still get:
readme: README contains the placeholder zenodo.XXXXXXX. This should be replaced with the zenodo doi (after the first release).
I had to do readme: false to remove it from the warnings.
Command used and terminal output
$ nf-core pipeline lint -d ./my-pipeline
...
readme: README contains the placeholder zenodo.XXXXXXX. This should be replaced with the zenodo doi (after the first release).
System information
I am using nfcore/gitpod:3.1.1
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 with the nf-core pipeline lint -d ./my-pipeline entry point and follow how the lint.readme settings in nf-core.yml are interpreted, especially zenodo_release. Reproduce the warning with the configuration shown and verify that the configured readme checks produce the expected warnings without requiring readme: false.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, yaml
- Domain
- cli, tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100