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

Check structure of update entry in .nf-core.yml #2037

Merged
merged 6 commits into from
Nov 25, 2022

Conversation

mirpedrol
Copy link
Member

Check that the structure of the update entry in .nf-core.yml is updated.
Should be

update:
  repo url:
    component install directory:
      component name:

Instead of

update:
  nf-core/modules:
    component name:

When a modules or subworkflow is set to false, the update doesn't fail, just skips this component (and it's dependencies in case of subworkflows).

PR checklist

  • This comment contains a description of changes (with reason)
  • CHANGELOG.md is updated
  • If you've fixed a bug or added code that should be tested, add tests!
  • Documentation in docs is updated

@codecov
Copy link

codecov bot commented Nov 22, 2022

Codecov Report

Merging #2037 (1ee11b0) into dev (4bf70e1) will decrease coverage by 0.00%.
The diff coverage is 33.33%.

@@            Coverage Diff             @@
##              dev    #2037      +/-   ##
==========================================
- Coverage   67.61%   67.60%   -0.01%     
==========================================
  Files          43       43              
  Lines        5567     5572       +5     
==========================================
+ Hits         3764     3767       +3     
- Misses       1803     1805       +2     
Impacted Files Coverage Δ
nf_core/components/update.py 81.67% <33.33%> (-0.54%) ⬇️
nf_core/modules/test_yml_builder.py 49.54% <0.00%> (+0.45%) ⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@awgymer
Copy link
Contributor

awgymer commented Nov 22, 2022

This, along with some of the other changes in recent PRs, and the potential of adding org_path to the config file made me wonder if we have defined somewhere the full list of what can be put and/or is expected in the .nf-core.yml?
Is it worth considering creating a simple schema?

@mashehu
Copy link
Contributor

mashehu commented Nov 22, 2022

I don't think we have it listed somewhere, but some documentation would for sure be helpful. not sure if we need to write a schema for it, because we already have so many config files, but some linting would for sure be good. On the other hand, we could the documentation with a schema, hmm 🤔

@awgymer
Copy link
Contributor

awgymer commented Nov 22, 2022

Ok I created a new issue so we can discuss/monitor without polluting this PR

@mashehu mashehu added this to the 2.7 milestone Nov 22, 2022
@mirpedrol mirpedrol merged commit bbb5415 into nf-core:dev Nov 25, 2022
@mirpedrol mirpedrol deleted the update-config branch November 25, 2022 11:38
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