Skip to content

Remove stale nf-core template remnants - #141

Merged
FloWuenne merged 2 commits into
mainfrom
cursor/remove-nfcore-remnants-bc8a
Apr 22, 2026
Merged

Remove stale nf-core template remnants#141
FloWuenne merged 2 commits into
mainfrom
cursor/remove-nfcore-remnants-bc8a

Conversation

@FloWuenne

@FloWuenne FloWuenne commented Apr 22, 2026

Copy link
Copy Markdown
Contributor

PR checklist

  • This comment contains a description of changes (with reason).
  • If you've fixed a bug or added code that should be tested, add tests!
  • If you've added a new tool, parameter, or workflow path, update the relevant docs.
  • If plugin declarations changed, update CITATIONS.md, README.md, and agent/context guidance in the same PR.
  • Ensure the test suite passes (nextflow run . -profile test,docker --outdir <OUTDIR>).
  • Check for unexpected warnings in debug mode (nextflow run . -profile debug,test,docker --outdir <OUTDIR>).
  • CHANGELOG.md is updated.
  • README.md is updated (including new tool citations and authors/contributors).

Description

Remove stale nf-core template residue that is no longer used, including deleting the leftover .nf-core.yml file that contradicted the repository guidance.

Also align plugin documentation and future agent guidance with the actual pinned plugins in nextflow.config by:

  • documenting nf-core-utils@0.4.0 and nf-schema@2.3.0 in CITATIONS.md
  • calling out the pinned plugin references from README.md
  • updating repo/agent context so future contributors re-check for stale nf-core-template remnants and keep plugin citations synchronized
  • renaming the main CI workflow label from nf-core CI to Pipeline CI so it reflects the current repository setup

Testing

  • uv run --with typer --with pyyaml --with jinja2 --with pyarrow --with pytest --with httpx pytest -v modules/local/aggregate_benchmark_report_data/tests/test_aggregate.py modules/local/normalize_benchmark_jsonl/tests/test_normalize.py modules/local/render_benchmark_report/tests/test_render.py bin/test_benchmark_report_fetch.py
  • nf-test test --profile=+docker --verbose
  • nextflow run . --input workflows/nf_aggregate/assets/test_benchmark.csv --generate_benchmark_report --outdir /tmp/nf-aggregate-e2e-results -profile docker
  • pre-commit run --all-files
Open in Web Open in Cursor 

Co-authored-by: Florian Wuennemann <flowuenne@gmail.com>
Comment thread CITATIONS.md Outdated

- [`nf-core-utils@0.4.0`](https://github.com/nf-core/nf-utils)

> Ewels PA, Peltzer A, Fillinger S, Patel H, Alneberg J, Wilm A, Garcia MU, Di Tommaso P, Nahnsen S. The nf-core framework for community-curated bioinformatics pipelines. Nat Biotechnol. 2020 Mar;38(3):276-278. doi: 10.1038/s41587-020-0439-x.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't think the utils plugin has a citation?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, that's a citation for nf-core in general.

no need for that for plugins, for me the URL is enough.
I would not even put versions as it's a pain to update whenever you update the plugin.

That being said, even if this is now diverging quite a lot from standard nf-core pipeline, I would still keep a general citation to nf-core.

Comment thread AGENTS.md

@FriederikeHanssen FriederikeHanssen left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding the citation back in

@maxulysse maxulysse left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

minor comments, but LGTM

Move the nf-core framework citation out of the plugin entry and into
its own section, consistent with the Nextflow citation above it.

Co-Authored-By: Claude <noreply@anthropic.com>
@FloWuenne

Copy link
Copy Markdown
Contributor Author

OK, I moved the citation for nf-core back to a general nf-core citation and out of nf-core-utils. I agree with @maxulysse that a general nf-core citation should remain, even if the template isn't used anymore!

@FloWuenne
FloWuenne marked this pull request as ready for review April 22, 2026 14:19
@FloWuenne
FloWuenne merged commit a5d9630 into main Apr 22, 2026
14 checks passed
@FloWuenne
FloWuenne deleted the cursor/remove-nfcore-remnants-bc8a branch April 22, 2026 14:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants