We're having issues with a PR and its linting, whe...
# modules
e
We're having issues with a PR and its linting, where we think that the linting action is erroneously picking up the module's Dockerfile as a module itself: https://github.com/nf-core/modules/pull/7233. I don't think this is a very common occurrence, since most modules don't have their own Dockerfiles, so one alternative is simply to ignore the errors and merge it regardless, or the linting action needs to be changed for handle cases such as these.
a
I can’t find the issue or thread right now, but I am certain this recently came up and indeed the issue is with how the tools finds modules to lint
e
Do you remember if there was any decision on how failing PRs should be treated until the issue is fixed?
a
Ok I found the issue where I saw this before. According to that I thought a fix had been applied, but maybe it was only for
bump-versions
and hasn’t fixed the issue for other commands which may be affected? (Although I am surprised no one has seen this issue with other lints already if that is the case)
e
Hmm, okay. Well, I'm not very surprised nobody else has seen it, since I'd think it would only happen when the Dockerfile itself is updated, which might not be something that would happen very often.
a
Having looked a bit more at your situation it seems like the actual issue may be a CI one and not an
nf-core modules lint
one.
The tool is failing because CI is trying to run
spaceranger/Dockerfile
I would suggest you look at a recent PR for
cellranger/mkref
(which I think is the module in the issue above) and see if it suffered the same issue
e
It is also trying to run
spaceranger
itself, so it's not just the Dockerfile
a
I mean, you can see how it gets the paths to run here. AFAIK we’ve never properly formalised how and if having non-module files in the
modules
path should really be allowed, but clearly a few modules have done this with
Dockerfile
but it’s now breaking (I suspect) because of a CI change
I suspect he other modules implementing this did so before that action was being used in this way.
e
Not a lot of modules use their own Dockerfiles, but in our case (and I assume the others as well) we simply have to create our own, as there is no official 10x images AFAIK. While a minority of modules have this issue, I think it would be good have some kind of formalisation for it, or at least have the CI handle them
a
Personally I dislike that the exceptions list is just an ever-growing
filter
Copy code
filter(x => !x.startsWith('main.nf') && x !== 'tests' && x !== 'templates' && x !== 'meta.yml' && x !== 'environment.yml' && !x.endsWith('.md'))
and I think it would be better if (as we both say above) allowed extra files were formalised.
s
Personally I dislike that the exceptions list is just an ever-growing
filter
What files is it actually finding there?
e
Agreed
a
It's trying to find any tool/subtool subdirectories rather than actual files
So the filter is basically trying to ignore any files we expect plus any dirs we expect in a module dir
I think it's quite a ropey way of doing it haha
s
right, can you not specify folders in whatever is leading to that?
and then you just want to exclude the tests and templates folders
I think it wants to be a positive selection rather than a negative selection
a
🤷🏼‍♂️
s
(i.e. not trying to exclude everything else that might be there )
e
This PR is now ready to be merged, but we can't because of the failing linting. What do we do?