tools icon indicating copy to clipboard operation
tools copied to clipboard

Automate pushing releases to WorkflowHub

Open ewels opened this issue 2 years ago • 3 comments

Description of feature

Write a GitHub action that automatically pushes new pipeline releases to https://workflowhub.eu/

Workflows should use a bespoke RO-Crate, so this depends on https://github.com/nf-core/tools/pull/703

  • https://about.workflowhub.eu/developer/ro-crate-api/
  • https://about.workflowhub.eu/Workflow-RO-Crate/
  • https://about.workflowhub.eu/developer/how-to-make-a-workflow-ro-crate/

ewels avatar Dec 09 '23 21:12 ewels

Hi @ewels

Can you please clarify "Workflows will need an RO-Crate" ? Workflows can be added to workflowhub.eu without having to pre-generate and provide a RO-crate: check https://workflowhub.eu/workflows/665 out. In fact, workflowhub can export a RO-Crate for this pipeline.

Also, FYI, the automated GitHub -> Workflowhub push has been raised by @tbrown91 (from the ERGA IT committee) to the WorkflowHub people. Here is their recommendation:

They pointed me to the Life Monitor, which was developed by the same people within EOSC, and they are planning to use this to automatically update workflows from galaxy and nf-core. They said the main thing to make sure is that the workflows follow the best practices (linked below)

https://crs4.github.io/life_monitor/ https://crs4.github.io/life_monitor/lm_wft_best_practices_github_app

and nf-core is considered the best practice for Nextflow (yeah 🎉 !)

muffato avatar Jan 03 '24 22:01 muffato

Hi @muffato,

Great point - the choice of words was poor, sorry (now edited). You're completely correct. However, in discussion with the WorkflowHub team we think it'd be nice for us to create our own RO-Crate files for workflows automatically so that we can add in as much rich metadata as possible. Much of this can and will be automated, but also having the file in the repository means that pipeline developers can edit it manually if needed. Given that the submission to workflowhub is automated, this means that there is a degree of control for them.

On the WFH side there should soon be an automated script to run a regular scrape and import nf-core pipelines to workflowhub.eu without this requirement, so it's not a blocker for getting the workflows there.

Phil

ewels avatar Jan 15 '24 09:01 ewels

Hello, I think this is automated now, can I close the issue?

mirpedrol avatar Mar 13 '25 09:03 mirpedrol