Skip to content

Patch 2.2.1#594

Merged
jfy133 merged 16 commits intomasterfrom
patch-2.2.1
Oct 29, 2020
Merged

Patch 2.2.1#594
jfy133 merged 16 commits intomasterfrom
patch-2.2.1

Conversation

@jfy133
Copy link
Copy Markdown
Member

@jfy133 jfy133 commented Oct 27, 2020

nf-core/eager pull request

This is a draft PR for first 2.2 patch, prior version bumping.

Once approved, will bump versions to 2.2.1 and make proper PR.

To close #591 and close #592 and close #590 and close #596 and to close #582

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 necessary, also make a PR on the nf-core/eager branch on the nf-core/test-datasets repo
  • Ensure the test suite passes (nextflow run . -profile test,docker --paired_end).
  • Make sure your code lints (nf-core lint .).
  • Documentation in docs is updated
  • CHANGELOG.md is updated
  • README.md is updated

Learn more about contributing: CONTRIBUTING.md

@jfy133 jfy133 marked this pull request as draft October 27, 2020 08:26
@github-actions
Copy link
Copy Markdown

Hi @jfy133,

It looks like this pull-request is has been made against the nf-core/eager master branch.
The master branch on nf-core repositories should always contain code from the latest release.
Because of this, PRs to master are only allowed if they come from the nf-core/eager dev branch.

You do not need to close this PR, you can change the target branch to dev by clicking the "Edit" button at the top of this page.

Thanks again for your contribution!

@jfy133 jfy133 requested a review from apeltzer October 27, 2020 08:27
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Oct 27, 2020

nf-core lint overall result: Failed ❌

Updated for pipeline commit 4693b8b

+| ✅ 67 tests passed       |+
!| ❗  1 tests had warnings |!
-| ❌  1 tests failed       |-
Details

❌ Test failures:

  • Test #5 - GitHub Actions AWS test should be triggered on workflow_dispatch and not on push or PRs: /home/runner/work/eager/eager/.github/workflows/awstest.yml

❗ Test warnings:

  • Test #4 - Config manifest.version should end in dev: '2.2.1'

✅ Tests passed:

  • Test #1 - File found: nextflow.config
  • Test #1 - File found: nextflow_schema.json
  • Test #1 - File found: LICENSE or LICENSE.md or LICENCE or LICENCE.md
  • Test #1 - File found: README.md
  • Test #1 - File found: CHANGELOG.md
  • Test #1 - File found: docs/README.md
  • Test #1 - File found: docs/output.md
  • Test #1 - File found: docs/usage.md
  • Test #1 - File found: .github/workflows/branch.yml
  • Test #1 - File found: .github/workflows/ci.yml
  • Test #1 - File found: .github/workflows/linting.yml
  • Test #1 - File found: main.nf
  • Test #1 - File found: environment.yml
  • Test #1 - File found: Dockerfile
  • Test #1 - File found: conf/base.config
  • Test #1 - File found: .github/workflows/awstest.yml
  • Test #1 - File found: .github/workflows/awsfulltest.yml
  • Test #1 - File not found check: Singularity
  • Test #1 - File not found check: parameters.settings.json
  • Test #1 - File not found check: bin/markdown_to_html.r
  • Test #1 - File not found check: .travis.yml
  • Test #3 - Licence check passed
  • Test #2 - Dockerfile check passed
  • Test #4 - Config variable found: manifest.name
  • Test #4 - Config variable found: manifest.nextflowVersion
  • Test #4 - Config variable found: manifest.description
  • Test #4 - Config variable found: manifest.version
  • Test #4 - Config variable found: manifest.homePage
  • Test #4 - Config variable found: timeline.enabled
  • Test #4 - Config variable found: trace.enabled
  • Test #4 - Config variable found: report.enabled
  • Test #4 - Config variable found: dag.enabled
  • Test #4 - Config variable found: process.cpus
  • Test #4 - Config variable found: process.memory
  • Test #4 - Config variable found: process.time
  • Test #4 - Config variable found: params.outdir
  • Test #4 - Config variable found: params.input
  • Test #4 - Config variable found: manifest.mainScript
  • Test #4 - Config variable found: timeline.file
  • Test #4 - Config variable found: trace.file
  • Test #4 - Config variable found: report.file
  • Test #4 - Config variable found: dag.file
  • Test #4 - Config variable found: process.container
  • Test #4 - Config variable (correctly) not found: params.version
  • Test #4 - Config variable (correctly) not found: params.nf_required_version
  • Test #4 - Config variable (correctly) not found: params.container
  • Test #4 - Config variable (correctly) not found: params.singleEnd
  • Test #4 - Config variable (correctly) not found: params.igenomesIgnore
  • Test #4 - Config timeline.enabled had correct value: true
  • Test #4 - Config report.enabled had correct value: true
  • Test #4 - Config trace.enabled had correct value: true
  • Test #4 - Config dag.enabled had correct value: true
  • Test #4 - Config manifest.name began with nf-core/
  • Test #4 - Config variable manifest.homePage began with https://github.com/nf-core/
  • Test #4 - Config dag.file ended with .svg
  • Test #4 - Config variable manifest.nextflowVersion started with >= or !>=
  • Test #4 - Config process.container looks correct: nfcore/eager:2.2.1
  • Test #5 - GitHub Actions 'branch' workflow is triggered for PRs to master: /home/runner/work/eager/eager/.github/workflows/branch.yml
  • Test #5 - GitHub Actions 'branch' workflow looks good: /home/runner/work/eager/eager/.github/workflows/branch.yml
  • Test #5 - GitHub Actions CI is triggered on expected events: /home/runner/work/eager/eager/.github/workflows/ci.yml
  • Test #5 - CI is building the correct docker image: docker build --no-cache . -t nfcore/eager:2.2.1
  • Test #5 - CI is pulling the correct docker image: docker pull nfcore/eager:dev
  • Test #5 - CI is tagging docker image correctly: docker tag nfcore/eager:dev nfcore/eager:2.2.1
  • Test #5 - Continuous integration checks minimum NF version: /home/runner/work/eager/eager/.github/workflows/ci.yml
  • Test #5 - GitHub Actions linting workflow is triggered on PR and push: /home/runner/work/eager/eager/.github/workflows/linting.yml
  • Test #5 - Continuous integration runs Markdown lint Tests: /home/runner/work/eager/eager/.github/workflows/linting.yml
  • Test #5 - Continuous integration runs nf-core lint Tests: /home/runner/work/eager/eager/.github/workflows/linting.yml

Run details:

  • nf-core/tools version 1.11
  • Run at 2020-10-27 12:25:14

@jfy133 jfy133 marked this pull request as ready for review October 28, 2020 08:32
Copy link
Copy Markdown
Contributor

@mashehu mashehu left a comment

Choose a reason for hiding this comment

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

While doing other things, I saw two smaller things in the docs you should change as well.

  • in usage.md please add a # Introduction after the Table of contents, so that it will not be rendered on the website.
  • in 'nextflow_schema.json`, could you please change fa-forward icons (:fast_forward:) to fa-fast-forward, for consistency with the other pipelines

Comment thread docs/usage.md
Comment on lines +2408 to +2413
> Note that with this you will _not_ have the automatic retry mechanism. If
> you want this, re-add the `check_max()` function on the `memory` line, and
> add to the bottom of the entire file (outside the profiles block), the
> block starting `def check_max(obj, type) {`, which is at the end of the
> [nextflow.config file](https://github.com/nf-core/eager/blob/master/nextflow.config)

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.

You could point to the old version of the file, to show that more clearly.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

What do you mean old version?

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.

To point to a version where you have this still in or to something similar.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Ah, I see - good point. I don't think it'll be removed for a long time as it's in the nf-core template and AFAIK it would still be valid for DSL2. But I'll note that for the next patch (had to release today because I'm running a workshop tomorrow and needed to make sure it's working 😅 )

@jfy133 jfy133 merged commit 7971d89 into master Oct 29, 2020
@jfy133 jfy133 deleted the patch-2.2.1 branch October 29, 2020 18:05
@jfy133 jfy133 restored the patch-2.2.1 branch October 29, 2020 18:05
@jfy133 jfy133 deleted the patch-2.2.1 branch November 3, 2020 11:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

3 participants