Any ideas why I'm still getting test failures here...
# tools
j
Any ideas why I'm still getting test failures here, when I've moved the location of a file in a template, and I think(?) I've updated all the paths accordingly in the template etc? https://github.com/nf-core/tools/pull/3903
m
I think you got the path wrong. See my comment
facepalm 1
j
Looks better, but still a few errosr 😞
m
It might be related to
nf_core/pipelines/create/template_features.yml
and adding the
docs/CONTRIBUTING.md
there?
Copy code
documentation:
      skippable_paths:
        - "docs"
      short_description: "Add documentation"
      description: "Add documentation to the pipeline"
      help_text: |
        This will add documentation markdown files where you can describe your pipeline.
        It includes:
        - docs/CONTRIBUTING.md: A contributing guide to help others contribute to your pipeline.
        - docs/README.md: A README file where you can describe the structure of your documentation.
        - docs/output.md: A file where you can explain the output generated by the pipeline
        - docs/usage.md: A file where you can explain the usage of the pipeline and its parameters.

        These files come with an exemplary documentation structure written.
      linting:
        files_exist:
          - "docs/CONTRIBUTING.md"
          - "docs/output.md"
          - "docs/README.md"
          - "docs/usage.md"
      nfcore_pipelines: False
      custom_pipelines: True
      default: true
Trying this at the moment… can’t run the CI without the self-hosted runners.
j
I'll try pushing to my branch!
m
Yup, much simpler to recreate than to meddle with the CI.
j
OK one final error...
image.png
Any final ideas?
I feel when I look around I'm just swimming in spaghetti, as a non-pythonista
m
okay, found the problem. You added a
nf-core TODO
and that is removed in this check (to avoid linting errors because of that), but is still in the template. Don't remember at the moment, why this isn't a problem in other files (hopefully tomorrow-morning–me remembers (or @Júlia Mir))
j
Oh jeez
Thanks for investigating @mashehu! I never would have worked that out 😅
j
I was trying to fix this error, I thought the solution was to lint the file partially (only the template content must be there but it can contain additional text), but this doesn't work either because of the TODO comment that will have to be removed
so I am wondering if we don't lint this file for content changes
j
Ah yeah that would make sense, the idea is you could modify the bottom of the file too...
m
but why does the README.md and usage.md etc. work even though they also have TODO statements?
j
we don't lint those
j
Is there anything for me to do at the moment?
j
no don't worry 😄 if you all agree I will remove this file form the linting and they you should be good to go
👍🏻 1
👍 1
j
And there isn't 'unchanged first half' checjk?
m
that's the partial-linting julia tried before
j
Ah I see
Well not fully... the todo is just at the end of the file right?
m
oh, to be more correct, partial linting allows appendices to the template, (we could add a linting end marker, but probably easier to just drop linting it for now)
j
OK fair enough
j
everything looks ✅ now 🙂
j
Woohoo! thank you very much @Júlia Mir @mashehu @Chris Hakkaart @Matthias Zepper!
Now once next templates are in, I can ask this page to berendered on teh website 😉