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 JSON schema for subworkflows meta.yml #6679

Conversation

mirpedrol
Copy link
Member

Update the JSON schema to validate subworkflows meta.yml. This adds the structure field to describe the structure of input and output channels.

input:
  - ch_fasta:
      description: A channel containing the reference fasta file.
      structure:
          - meta:
              type: map
              description: meta map
          - fasta:
              type: file
              description: fasta file
              path: "*.fasta"
  - ch_fai:
      description: channel containing fasta.fai file
      structure: 
          - meta:
              type: map
              description: meta map
          - fai:
              type: file
              description: fasta.fai file
output:
  - versions:
      description: channel containing software versions file
      structure:
          - versions.yml
                type: file
                description: file containing versions of the software used
  - mutect2_vcf:
      description: Channel containing a list of compressed vcf files
      structure:
          - meta:
              type: map
              description: meta map
          - vcf:
              type: file
              description: vcf file 

@mirpedrol
Copy link
Member Author

@nf-core-bot fix linting

Copy link

Nothing for me to do here! 🤷
This is probably because the linting errors come from nf-core lint and have to be fixed manually (or with nf-core lint --fix).

Copy link
Contributor

@nvnieuwk nvnieuwk left a comment

Choose a reason for hiding this comment

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

LGTM!

@mirpedrol
Copy link
Member Author

I have decided to update some subworkflows to test the JSON file and have them as examples.
I was hoping that it wouldn't take too much and I could update all of them but let's see where do we get 😉

Copy link
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.

If you could add the language-server link to the json schema at the start of all files to so we start adding them, that would be great

@mirpedrol mirpedrol changed the base branch from master to subworkflows_meta_yml October 25, 2024 12:09
@mirpedrol
Copy link
Member Author

Merging this to a dedicated branch subworkflows_meta_yml, the idea is to work on this branch during the hackathon and then merge this to master.

@mirpedrol mirpedrol merged commit 15e86fb into nf-core:subworkflows_meta_yml Oct 25, 2024
33 of 47 checks passed
mirpedrol added a commit that referenced this pull request Oct 28, 2024
* update JSON schema for subworkflows meta.yml

* fix patternProperties

* manually curate some swf meta.yml files
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.

3 participants