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

Remove tags in tests and tag.yml #6502

Closed

Conversation

chriswyatt1
Copy link
Contributor

@chriswyatt1 chriswyatt1 commented Aug 30, 2024

PR checklist

Closes #6001

  • 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

@nvnieuwk
Copy link
Contributor

I think we should keep the tags in the test file. This will make testing in pipelines a lot easier

@chriswyatt1
Copy link
Contributor Author

Ah ok, yes, if they are needed then we shouldn't default remove them from all the modules

@edmundmiller
Copy link
Contributor

edmundmiller commented Aug 30, 2024

I think we should revisit the tags in the modules. With the new "only test what's changed" and dependencies in nf-test I'm not sure the amount of tags is necessary.

Not sure what to do differently but it's just overkill.

Think that's outside the scope of this PR I think removes the yamls is safe.

@nvnieuwk
Copy link
Contributor

nvnieuwk commented Sep 2, 2024

Yeah that's mostly fine in modules but it does help in pipelines where you want to test a specific part of your pipeline. The tags are mostly automated by tools anyway so it's no extra work for developers.

@jfy133
Copy link
Member

jfy133 commented Sep 4, 2024

I feel the tags are still useful for doing one off tests while developping, but the modules and modules_nf-core oones are not that useful.

So I vote to remove those two and keep just the ones that are specific to that module (e.g. that module, and any upstream modules used during teh testing)

@jfy133
Copy link
Member

jfy133 commented Sep 4, 2024

I think we should revisit the tags in the modules. With the new "only test what's changed" and dependencies in nf-test I'm not sure the amount of tags is necessary.

The only test what's changed is fine for just testing on GHA (I would presume?) Not locally, or?

@maxulysse
Copy link
Member

I think it's overkill to have tags too, so for all removal

@jfy133
Copy link
Member

jfy133 commented Sep 4, 2024

wait I'm confused, is the purpose of this to have literally 0 tags at all?

@mirpedrol
Copy link
Member

Hi! We have some issues in tools to update the pipeline template so that we don't need tags in modules, see nf-core/tools#2855 and nf-core/tools#2854.
So it looks OK to remove them.

To test only one module, you can use the path, so there's no need to use a tag.

@mirpedrol mirpedrol deleted the branch nf-core:batch_update_staging September 20, 2024 12:38
@mirpedrol mirpedrol closed this Sep 20, 2024
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.

6 participants