Skip to content
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.

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

Support multiple file versions #1247

Merged
merged 44 commits into from
Sep 24, 2021
Merged

Support multiple file versions #1247

merged 44 commits into from
Sep 24, 2021

Conversation

mahesh-panchal
Copy link
Member

@mahesh-panchal mahesh-panchal commented Aug 2, 2021

Add support for multiple software version emissions and multiple software versions emitted as a result.

PR checklist

  • This comment contains a description of changes (with reason)
  • CHANGELOG.md is updated
  • If you've fixed a bug or added code that should be tested, add tests!
  • Documentation in docs is updated

@codecov
Copy link

codecov bot commented Aug 2, 2021

Codecov Report

Merging #1247 (06cdece) into dev (92c1651) will not change coverage.
The diff coverage is n/a.

❗ Current head 06cdece differs from pull request most recent head 82ce4b4. Consider uploading reports for the commit 82ce4b4 to get more accurate results
Impacted file tree graph

@@           Coverage Diff           @@
##              dev    #1247   +/-   ##
=======================================
  Coverage   67.45%   67.45%           
=======================================
  Files          50       50           
  Lines        5607     5607           
=======================================
  Hits         3782     3782           
  Misses       1825     1825           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 92c1651...82ce4b4. Read the comment docs.

@mahesh-panchal
Copy link
Member Author

So now I have some questions.

  1. Is it ok that the tsv file that goes into pipeline info is now a yml file (and by consequence removes the need for the python script)?
  2. How are the MultiQC and FastQC processes included in the template? Since there are changes here to the module template and the pipeline template, how should I be handling this? I see shasums so I figure a manual change is not correct?
  3. Is the MultiQC input fine?

@grst grst mentioned this pull request Aug 4, 2021
14 tasks
@grst
Copy link
Member

grst commented Aug 10, 2021

Working on a reference implementation in rnaseq to check if anything breaks: nf-core/rnaseq#689

I already learned that a yaml dict looks like

foo:
  key: value

rather than

foo:
   -key: value

@mahesh-panchal
Copy link
Member Author

Anyone got any pointers to this trim_galore failing test? I don't know what I need to change for this.

@mahesh-panchal
Copy link
Member Author

mahesh-panchal commented Aug 16, 2021

Still to do:

  • Docs?
  • Linting ( lint HEREDOC in module ) (this is done by the new tests in the modules repo)
  • MQC version / Software Versions version inclusion?
  • Additional tests?

@edmundmiller edmundmiller self-requested a review September 7, 2021 19:10
@grst grst marked this pull request as ready for review September 8, 2021 07:00
@grst
Copy link
Member

grst commented Sep 8, 2021

Linting ( lint HEREDOC in module )

We check on the modules side if versions.yml is generated + valid YAML, so maybe this isn't even required. In that case the old check for *.version.txt would need to be removed, though.

@edmundmiller
Copy link
Contributor

Sorry for adding myself as a reviewer, I thought this was supporting multiple versions of modules. This all looks really clean to me though, feel free to ping me if you want someone to test it out!

@edmundmiller edmundmiller removed their request for review September 12, 2021 21:15
@mahesh-panchal
Copy link
Member Author

I was actually waiting for input from you @emiller88 since you're the linting expert. There was a question whether we needed to add extra linting, and to check I haven't removed anything essential from linting too.

@mahesh-panchal
Copy link
Member Author

Anyone got any pointers to this trim_galore failing test? I don't know what I need to change for this.

This is still an issue too.

@mahesh-panchal
Copy link
Member Author

mahesh-panchal commented Sep 14, 2021

In that case the old check for *.version.txt would need to be removed, though.

I think we've already done this. I've gone through the code again to make sure there are no more references or checks for *version[s]?.txt

@grst
Copy link
Member

grst commented Sep 23, 2021

The following tests fail (expectedly):

  • The trimgalore test fails because the functions.nf from the modules repository does not include all expected functions (we add one to the template in this PR) and because the functions.nf is outdated.
  • the "RunTestWorkflow" fails because the pipeline-template still contains old modules (which produce a version.txt instead of a versions.yml which can't be handled by the new module to collect versions.

Copy link
Member

@drpatelh drpatelh left a comment

Choose a reason for hiding this comment

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

Great work guys! Glad to be finally merging this :)

@drpatelh drpatelh merged commit f8c72e3 into nf-core:dev Sep 24, 2021
@mahesh-panchal mahesh-panchal deleted the support_multiple_file_versions branch September 24, 2021 08:10
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.

4 participants