Skip to content

Add tests, use ena-webin-cli handler, refactor modules.conf and update docs#39

Merged
ochkalova merged 48 commits intodevfrom
add_tests
Mar 30, 2026
Merged

Add tests, use ena-webin-cli handler, refactor modules.conf and update docs#39
ochkalova merged 48 commits intodevfrom
add_tests

Conversation

@ochkalova
Copy link
Copy Markdown
Contributor

@ochkalova ochkalova commented Mar 19, 2026

Features:

Tests:

Bug fixes:

Other:

  • massive docs update
  • refactor modules.config and clean up published results
  • WEBIN_ACCOUNT renamed to ENA_WEBIN, WEBIN_PASSWORD to ENA_WEBIN_PASSWORD

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 - have you followed the pipeline conventions in the contribution docs
  • If necessary, also make a PR on the nf-core/seqsubmit branch on the nf-core/test-datasets repository.
  • Make sure your code lints (nf-core pipelines lint).
  • 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>).
  • Usage Documentation in docs/usage.md is updated.
  • Output Documentation in docs/output.md is updated.
  • CHANGELOG.md is updated.
  • README.md is updated (including new tool citations and authors/contributors).

@nf-core-bot
Copy link
Copy Markdown
Member

Warning

Newer version of the nf-core template is available.

Your pipeline is using an old version of the nf-core template: 3.5.1.
Please update your pipeline to the latest version.

For more documentation on how to update your pipeline, please see the nf-core documentation and Synchronisation documentation.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 19, 2026

nf-core pipelines lint overall result: Passed ✅ ⚠️

Posted for pipeline commit b100a7d

+| ✅ 251 tests passed       |+
#| ❔   7 tests were ignored |#
!| ❗  15 tests had warnings |!
Details

❗ Test warnings:

  • readme - README contains the placeholder zenodo.XXXXXXX. This should be replaced with the zenodo doi (after the first release).
  • pipeline_todos - TODO string in README.md: Add citation for pipeline after first release. Uncomment lines below and update Zenodo doi and badge at the top of this file.
  • pipeline_todos - TODO string in README.md: Add bibliography of tools and data used in your pipeline
  • pipeline_todos - TODO string in nextflow.config: Optionally, you can add a pipeline-specific nf-core config at https://github.com/nf-core/configs
  • pipeline_todos - TODO string in nextflow.config: Update the field with the details of the contributors to your pipeline. New with Nextflow version 24.10.0
  • pipeline_todos - TODO string in test_full.config: Specify the paths to your full test data ( on nf-core/test-datasets or directly in repositories, e.g. SRA)
  • pipeline_todos - TODO string in test_full.config: Give any required params for the test so that command line flags are not needed
  • pipeline_todos - TODO string in main.nf: Optionally add in-text citation tools to this list.
  • pipeline_todos - TODO string in main.nf: Optionally add bibliographic entries to this list.
  • pipeline_todos - TODO string in main.nf: Only uncomment below if logic in toolCitationText/toolBibliographyText has been filled!
  • pipeline_todos - TODO string in awsfulltest.yml: You can customise AWS full pipeline tests as required
  • pipeline_todos - TODO string in methods_description_template.yml: #Update the HTML below to your preferred methods description, e.g. add publication citation for this pipeline
  • pipeline_todos - TODO string in nextflow.config: Specify any additional parameters here
  • local_component_structure - rna_detection.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - genome_evaluation.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure

❔ Tests ignored:

  • files_exist - File is ignored: conf/igenomes.config
  • files_exist - File is ignored: conf/igenomes_ignored.config
  • nextflow_config - Config variable ignored: params.input
  • files_unchanged - File ignored due to lint config: .github/PULL_REQUEST_TEMPLATE.md
  • files_unchanged - File ignored due to lint config: assets/nf-core-seqsubmit_logo_light.png
  • files_unchanged - File ignored due to lint config: docs/images/nf-core-seqsubmit_logo_light.png
  • files_unchanged - File ignored due to lint config: docs/images/nf-core-seqsubmit_logo_dark.png

✅ Tests passed:

Run details

  • nf-core/tools version 3.5.1
  • Run at 2026-03-30 09:16:24

@ochkalova ochkalova changed the base branch from feature/genome-submission to dev March 19, 2026 11:28
Copy link
Copy Markdown
Collaborator

@vagkaratzas vagkaratzas left a comment

Choose a reason for hiding this comment

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

Please don't break/remove template stuff now, because you will regret later during new nf-core tools releases, with template merge PRs :D

Left some comments (will leave some more).

Also, if you haven't already done that, before the first release, we will need the def toolCitationText() and def toolBibliographyText() functions of subworkflows/local/utils_nfcore_seqsubmit_pipeline filled with actual citations data (see proteinfamilies pipeline on how to do this).

Copy link
Copy Markdown
Collaborator

@mberacochea mberacochea left a comment

Choose a reason for hiding this comment

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

Thanks @ochkalova ... I've left some comments!

Copy link
Copy Markdown
Collaborator

@vagkaratzas vagkaratzas left a comment

Choose a reason for hiding this comment

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

Alright for me for now. I guess it's better to have the end-to-end snapshots on a subsequent PR (+ some of the other Issues on the standby). I'd recommend 1 PR per 1 issue ;)

@vagkaratzas
Copy link
Copy Markdown
Collaborator

Alright for me for now. I guess it's better to have the end-to-end snapshots on a subsequent PR (+ some of the other Issues on the standby). I'd recommend 1 PR per 1 issue ;)

Oh the snapshots are there, but guess some extra files require to be in the .nftignore to make them stable.

@vagkaratzas
Copy link
Copy Markdown
Collaborator

Alright for me for now. I guess it's better to have the end-to-end snapshots on a subsequent PR (+ some of the other Issues on the standby). I'd recommend 1 PR per 1 issue ;)

Oh the snapshots are there, but guess some extra files require to be in the .nftignore to make them stable.

For example, since you changed this path in multiqc module config:
path: { "${params.outdir}/${params.mode}/multiqc" },
You will have to add all mode paths to multiqc.log in the .nftignore.

@ochkalova
Copy link
Copy Markdown
Contributor Author

ochkalova commented Mar 27, 2026

For example, since you changed this path in multiqc module config:
path: { "${params.outdir}/${params.mode}/multiqc" },
You will have to add all mode paths to multiqc.log in the .nftignore.

Well, I reverted it back to path: { "${params.outdir}/multiqc" }, because it's not mode specific thingy. But multiqc files are already in the snapshots. Snapshots have to be updated 🔨

@ochkalova ochkalova dismissed mberacochea’s stale review March 30, 2026 09:31

Martin is on AL and I had his verbal approval. Also he planned to do corrections in another branch anyway, so I'll dismiss his review for now

@ochkalova ochkalova merged commit 4a8d78a into dev Mar 30, 2026
20 checks passed
@ochkalova ochkalova deleted the add_tests branch March 30, 2026 09:33
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.

Output the list of assigned accessions after pipeline execution

5 participants