search

projectsyn / documentation

The Project Syn main documentation repository
https://docs.syn.tools/
BSD 3-Clause "New" or "Revised" License
6 stars 3 forks source link

Add SDD for Commodore Compile Pipeline #181

Closed HappyTetrahedron closed 3 weeks ago

HappyTetrahedron commented 1 month ago

Checklist

simu commented 3 weeks ago

I fixed and made the title of the SDD more specific for GitLab since there might be a future SDD for GitHub or Forgejo.

If we actually want to make this SDD title specific to GitLab, we'll also need to rename the source file, otherwise it will look very confusing.

Edit: Additionally, I'm not sure this needs to be made specific to GitLab in the title; if there's a future SDD for another Git hosting platform, I'd assume that it would be something along the lines of SDD 00XY - Forgejo as GitRepo provider where we can discuss everything that needs to be extended to support this.

Edit 2: Overall, my hope is that the structure we come up with here would be applicable for most Git hosting platforms. Afaict we could easily use the exact same structure discussed here to configure GitHub actions, and iirc Gitea/Forgejo actions are modeled after GH actions so that should just work(tm) as well.

HappyTetrahedron commented 3 weeks ago

IMO adding GitLab to the title has the main benefit of making it immediately clear that other git hosts are not yet supported (even though the architecture is generic enough to enable that in the future).

simu commented 3 weeks ago

IMO adding GitLab to the title has the main benefit of making it immediately clear that other git hosts are not yet supported (even though the architecture is generic enough to enable that in the future).

While that's true, explicitly mentioning GitLab in the title also gives the impression that the contents of this SDD aren't applicable for other Git hosting solutions when they clearly are.

HappyTetrahedron commented 3 weeks ago

@simu you have convinced me. I changed it back, but added a sentence at the start specifying that we're only supporting GitLab for now.

bastjan commented 3 weeks ago

I agree that it should be generic enough for other Git/CI hosts. I did find the combination of "Commodore Compile Pipeline" and then out-of-scope "any other systems" and the interweaving of generic and GitLab terms a bit confusing. No hard feelings though not making it more specific to GitLab. (The copy-paste error in the title still needs fixing tho 😉)