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

Update test.yml specifically verify markdown part with new schema associated with modules #151

Merged
merged 5 commits into from
Oct 30, 2024

Conversation

rhshah
Copy link
Collaborator

@rhshah rhshah commented Oct 4, 2024

Update for new modules schema

PR checklist

Closes ###

  • Updating to new schema for verify markdown test in test.yml workflow.
  • Check to see if a nf-core module, or subworkflow is available and usable for your pipeline.
  • Feature branch is named feature/<module_name> for modules, or feature/<subworkflow_name> for subworkflows. For modules, if there is a subcommand use: feature/<module_name>/<module_subcommand>.
  • 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.
  • Use nf-core data if possible for nf-tests. If not, use or add test data to mskcc-omics-workflows/test-datasets, following the repository guidelines, for nf-tests. Finally, if neither option is feasible, only add a stub nf-test.
  • 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 Jfrog 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 --git-remote https://github.com/mskcc-omics-workflows/modules.git -b <module_branch> test <MODULE> --profile docker
      • nf-core modules --git-remote https://github.com/mskcc-omics-workflows/modules.git -b <module_branch> test <MODULE> --profile singularity
      • nf-core modules --git-remote https://github.com/mskcc-omics-workflows/modules.git -b <module_branch> test <MODULE> --profile conda
    • For subworkflows:
      • nf-core subworkflows --git-remote https://github.com/mskcc-omics-workflows/modules.git -b <subworkflow_branch> test <SUBWORKFLOW> --profile docker
      • nf-core subworkflows --git-remote https://github.com/mskcc-omics-workflows/modules.git -b <subworkflow_branch> test <SUBWORKFLOW> --profile singularity
      • nf-core subworkflows --git-remote https://github.com/mskcc-omics-workflows/modules.git -b <subworkflow_branch> test <SUBWORKFLOW> --profile conda

Update for new modules schema
@rhshah rhshah requested a review from a team as a code owner October 4, 2024 04:36
@rhshah rhshah self-assigned this Oct 4, 2024
@rhshah rhshah added the bug Something isn't working label Oct 4, 2024
@rhshah rhshah changed the title Update test.yml Update test.yml specifically verify markdown part with new schema associated with modules Oct 4, 2024
@rhshah
Copy link
Collaborator Author

rhshah commented Oct 4, 2024

@huyu335 can you check if this is all we need to do, I updated the schema in yaml_to_md, made a release and modified the following parts in test.yml

@huyu335
Copy link
Collaborator

huyu335 commented Oct 4, 2024

@huyu335 can you check if this is all we need to do, I updated the schema in yaml_to_md, made a release and modified the following parts in test.yml

Hi @rhshah thanks for the update! I also added one commit to update the generation of markdown files.

Also update schema json files from nf-core modules.

@huyu335
Copy link
Collaborator

huyu335 commented Oct 4, 2024

Also did a small testing. Verifying markdown does not show any error now.

@buehlere buehlere merged commit fe69b89 into develop Oct 30, 2024
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants