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

Updated the meta.yml of subworkflows #7072

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

muneebdev7
Copy link

@muneebdev7 muneebdev7 commented Nov 23, 2024

PR checklist

Closes #6737

  • Forked the nf-core/modules repo and edited in nf-core/gitpod.
  • Then performed the nf-core lint --fix for each subworkflow in the repo.
  • Commits in this PR are the updated meta.yml files.

  • 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 module conventions in the contribution docs
  • If necessary, include test data in your PR.
  • Remove all TODO statements.
  • Emit the versions.yml file.
  • Follow the naming conventions.
  • Follow the parameters requirements.
  • Follow the input/output options guidelines.
  • Add a resource label
  • Use BioConda and BioContainers if possible to fulfil software requirements.
  • Ensure that the test works with either Docker / Singularity. Conda CI tests can be quite flaky:
    • For modules:
      • nf-core modules test <MODULE> --profile docker
      • nf-core modules test <MODULE> --profile singularity
      • nf-core modules test <MODULE> --profile conda
    • For subworkflows:
      • nf-core subworkflows test <SUBWORKFLOW> --profile docker
      • nf-core subworkflows test <SUBWORKFLOW> --profile singularity
      • nf-core subworkflows test <SUBWORKFLOW> --profile conda

- versions:
type: file
description: File containing software versions
pattern: "versions.yml"
- bins:
description: ""
Copy link
Member

Choose a reason for hiding this comment

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

I don't really understand this change, why has it deleted the old description and just moved it down?

And why is it removing meta, (which should be in all output channels except versions in this case)

@mirpedrol can you provide more context what tools is trying to do here?

Copy link
Member

Choose a reason for hiding this comment

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

The lint command with --fix is fixing the structure of the meta, adding all input and output channels, for example in this case bin is not a channel, because it's called bins. But the description or structure can't be automatized, this must be fixed manually by copying the old descirption and/or checking the main.nf of the subworkflow and meta.yml of the included modules to know the proper content of the channels.

Copy link
Member

Choose a reason for hiding this comment

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

Ahhh, completely missed that typo, my bad!

OK thank you :)

@@ -46,6 +47,10 @@ output:
description: |
Files containing software versions
Structure: [ path(versions.yml) ]
- //:
Copy link
Member

Choose a reason for hiding this comment

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

This also seems broken... @mirpedrol ?

Copy link
Member

Choose a reason for hiding this comment

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

This is but in tools, probably because of a multiline comment, thanks for pointing this out!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update the meta.yml of subworkflows
3 participants