seqeralabs / nf-tower

Nextflow Tower system

Home Page:https://tower.nf

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

[Feature Idea] Create pre-filled Github Issue from failed pipeline run

apeltzer opened this issue · comments

Hi!

Just an idea and maybe that was raised already in the past. At nf-core, we for example ask people to fill out a couple of basic things about the system they were running their analysis on etc.

It would be great if tower could simplify this process, e.g. receive a button that becomes active when running a pipeline and the run failed to "Submit issue to github ..." and use the Github URL of the executed pipeline to open an issue and prefill some of the information required there. An example could be that this includes already a pre-filled system environment, some logs (?) and the configuration of the pipeline so that more experienced people could help users in debugging whats going on without having to ask multiple times for these sorts of information.

Up for discussion of course, I just think it could be done relatively easily and would make debugging with external help easier. Everything we need should already exist on a failed pipeline run on tower:

  • URL of the repository, thus Github issue url can be deduced
  • log / config
  • parameters of run

With pipeline secrets in general availability, this would also work in a way without compromising (hopefully?) any user details by sharing the logfiles.

I like the idea. Another approach could be that Tower generates an open but secret URL that gives all this information taking care of anonymizing everything (paths, IPs, random strings...) Then you can share this in a github issue, slack channel or at whatever place you want.

Sounds great indeed yes!