showyourwork / showyourwork

A workflow for reproducible and open scientific articles

Home Page:https://show-your.work

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

GitLab support

HealthyPear opened this issue · comments

I see that GitHub support is already there.

Apart from interfacing with remote repositories and supporting the URL logos, is there any particular blocker to support GitLab repositories?

The current implementation of SYW is actually extremely tightly integrated with GitHub because of its heavy use of Actions throughout the workflow. There's an existing issue tracking some refactoring of this (#296), but it's not extremely high priority, I'd say. I'm definitely keen to make SYW compatible with GitLab and other hosts in the long run!

I see. It seems that the main blocker is the action right? Perhaps making that optional with an on_github: false in showyourwork.yml might work?

I don't think GitLab cares about the .github directory, so the actual content about Github shouldn't need to be changed.

Perhaps the only limitation is that GitLab doesn't have something like GitHub's Actions marketplace. This could be solved by providing a minimal .gitlab-ci.yml to replicate what this action does.

That would be a start, but the current implementation actually assumes GitHub throughout, so actually fixing this sensibly would require a more thorough overhaul. I'm going to label this with the v1.0 label, since I think it will be a lot easier to implement this on the dev branch (that is explicitly decoupled from GitHub), instead of trying to patch the main branch.