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

Release PR for 3.0 #616

Merged
merged 57 commits into from
May 13, 2024
Merged

Release PR for 3.0 #616

merged 57 commits into from
May 13, 2024

Conversation

jfy133
Copy link
Member

@jfy133 jfy133 commented May 10, 2024

TODO:

  • Update versions
  • Update workflow diagram if necessary

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/mag branch on the nf-core/test-datasets repository.
  • Make sure your code lints (nf-core 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).

jfy133 and others added 30 commits February 12, 2024 20:24
Add test configs for krona and concoct
Update gtdbtk classifywf so doesn't break when mashdb given
…Samplesheet/map function in utils_nfcore_mag_pipeline
@jfy133 jfy133 marked this pull request as draft May 10, 2024 13:24
Copy link

github-actions bot commented May 10, 2024

nf-core lint overall result: Passed ✅ ⚠️

Posted for pipeline commit fa8f6ef

+| ✅ 304 tests passed       |+
#| ❔   2 tests were ignored |#
!| ❗   6 tests had warnings |!

❗ Test warnings:

  • nextflow_config - Config manifest.version should end in dev: 3.0.0
  • pipeline_todos - TODO string in main.nf: Remove this line if you don't need a FASTA file [TODO: try and test using for --host_fasta and --host_genome]
  • 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 methods_description_template.yml: #Update the HTML below to your preferred methods description, e.g. add publication citation for this pipeline

❔ Tests ignored:

✅ Tests passed:

Run details

  • nf-core/tools version 2.14.1
  • Run at 2024-05-10 14:17:47

@jfy133 jfy133 marked this pull request as ready for review May 10, 2024 14:04
main.nf Outdated Show resolved Hide resolved
modules.json Outdated Show resolved Hide resolved
Copy link
Member

@maxulysse maxulysse left a comment

Choose a reason for hiding this comment

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

Minor comments

Copy link
Member

@maxulysse maxulysse left a comment

Choose a reason for hiding this comment

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

<3

Copy link
Contributor

@CarsonJM CarsonJM left a comment

Choose a reason for hiding this comment

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

A monumental effort by @jfy133!!!

Copy link
Member

@erikrikarddaniel erikrikarddaniel left a comment

Choose a reason for hiding this comment

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

Looks good with a couple of questions:

  1. Is it the new behaviour of --input that merits the 2.5.4 -> 3.0?
  2. I saw a number of closed issues yesterday in emails, e.g. CheckM2 and dRep, but I don't see these changes included here.
  3. Fonts in the svg files appear different

@jfy133
Copy link
Member Author

jfy133 commented May 13, 2024

Looks good with a couple of questions:

  1. Is it the new behaviour of --input that merits the 2.5.4 -> 3.0?
  2. I saw a number of closed issues yesterday in emails, e.g. CheckM2 and dRep, but I don't see these changes included here.
  3. Fonts in the svg files appear different

Thanks @erikrikarddaniel !

To answer your questions:

  1. Yes exactly :) Because we drop support for direct fastq input --input '*{R1,R2}.fasta.gz , I consider this a backwards incompatible change, so following semvar this would equate to an API breaking change
  2. They've not been added to the pipeline, I just did some issue cleanup as I saw a bunch of duplicates, so just consolidating the issues
  3. That's an system rendering issue thing on SVGs. I didn't convert text to paths, so if you don't have the font on your system it'll fallback to something else. As we normally only use PNGs for actual display, I leave the SVGs raw so the text remains editable:)

I hope that answers your questions!

@erikrikarddaniel
Copy link
Member

Regarding no 2: Since I just started a run and saw the closed issues, I had some hopes of finding those features in 3.0, giving me extra motivation to look at the PR 😉.

@jfy133
Copy link
Member Author

jfy133 commented May 13, 2024

Regarding no 2: Since I just started a run and saw the closed issues, I had some hopes of finding those features in 3.0, giving me extra motivation to look at the PR 😉.

Aha, well one of them already has a module (checkm2 I think), so I promise to prioritise this for your review.😬

But highest priority now is adding nf-test so we can be sure we stop breaking things 😅

workflows/mag.nf Outdated Show resolved Hide resolved
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.

One minor comment!

workflows/mag.nf Outdated Show resolved Hide resolved
@jfy133 jfy133 merged commit a50117e into master May 13, 2024
32 of 33 checks passed
@harper357 harper357 linked an issue Nov 18, 2024 that may be closed by this pull request
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.

7 participants