Skip to content

nf-core/nf-test guide #3387

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Draft
wants to merge 19 commits into
base: main
Choose a base branch
from
Draft

nf-core/nf-test guide #3387

wants to merge 19 commits into from

Conversation

@sateeshperi
Copy link
Contributor

@sateeshperi sateeshperi commented Jun 10, 2025 •
edited by nf-core-bot
Loading

@netlify /docs/tutorials/tests_and_test_data/components/01_installation

@netlify
Copy link

netlify bot commented Jun 10, 2025 •
edited
Loading

✅ Deploy Preview for nf-core-main-site ready!

Name Link
🔨 Latest commit b87864c
🔍 Latest deploy log https://app.netlify.com/projects/nf-core-main-site/deploys/68a16f32a8ebe40008ffcd7e
😎 Deploy Preview https://deploy-preview-3387--nf-core-main-site.netlify.app/docs/tutorials/tests_and_test_data/components/01_installation
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@mashehu
Copy link
Contributor

mashehu commented Jun 10, 2025

@nf-core-bot fix linting

jfy133
jfy133 reviewed Jun 10, 2025
View reviewed changes
Copy link
Member

@jfy133 jfy133 left a comment

Choose a reason for hiding this comment

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

I still feel this should go under the nf-core tutorials section of the tutorials section of the docs page

jfy133
jfy133 reviewed Jun 10, 2025
View reviewed changes
Copy link
Member

@jfy133 jfy133 left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Started, will try to finish later one

@sateeshperi sateeshperi changed the title polished and condensed docs nf-core/nf-test guide Jun 10, 2025
jfy133
jfy133 reviewed Jun 11, 2025
View reviewed changes
Copy link
Member

@jfy133 jfy133 left a comment

Choose a reason for hiding this comment

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

A few more comments forgot to press' submit reivew' on

@sateeshperi @jfy133
Apply suggestions from code review
5421cad 
Co-authored-by: James A. Fellows Yates <[email protected]>
prototaxites
prototaxites reviewed Jun 19, 2025
View reviewed changes
Copy link
Contributor

@prototaxites prototaxites left a comment

Choose a reason for hiding this comment

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

Couple of suggestions about testing the expected contents of a file - I could add another example about re-implementing a filter but I'm not sure which section it would go in

jfy133
jfy133 reviewed Aug 15, 2025
View reviewed changes
sites/docs/src/content/docs/tutorials/tests_and_test_data/components/07_assertions.md

Use withName selectors to assign `ext.args` values to a specific process. Both directives work within the scope they are defined in.

### File Path Handling
Copy link
Member

Choose a reason for hiding this comment

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

Based on what we talked about: I think we need somewhere some basic backgoround on the use of file vs path

And also basic background of how we have to handle multiple files being emitted as a list

@sateeshperi
Copy link
Contributor Author

@nf-core-bot fix linting

@github-actions github-actions bot deleted a comment from netlify bot Aug 17, 2025
@sateeshperi
Remove outdated documentation on nf-test assertions and migration fro…
ba41ea1 
…m pytest, and restructure the tutorial content for better clarity and organization. Add new sections on repository setup, testing modules, subworkflows, pipelines, assertions, test data management, CI/CD integration, and command usage.
@sateeshperi
Revise nf-test comprehensive guide for clarity and organization. Upda…
0e44c89 
…te section links, improve diagrams for project setup, module testing, subworkflow testing, pipeline testing, test data management, CI/CD integration, and command usage. Remove outdated content and enhance overall structure.
@sateeshperi
Update nf-test documentation for installation, project setup, and tes…
6469170 
…ting modules. Revise installation commands for clarity, and correct section links for better navigation. Improve assertions and next steps guidance across multiple components.
@sateeshperi
Add example of parameterized pipeline testing pattern. Adjust next st…
b87864c 
…eps references to ensure consistency across the tutorial.
@sateeshperi sateeshperi marked this pull request as ready for review August 17, 2025 06:07
@sateeshperi sateeshperi marked this pull request as draft August 17, 2025 10:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jfy133 jfy133 Awaiting requested review from jfy133

@Joon-Klaps Joon-Klaps Awaiting requested review from Joon-Klaps

@prototaxites prototaxites Awaiting requested review from prototaxites

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@sateeshperi @mashehu @jfy133 @prototaxites @Joon-Klaps @nf-core-bot