Usage of other github repos - need consistent WELL doc'ed way

opendevstack / PMC

Documents, policies, etc. related to governing the project

1 stars 2 forks source link

Usage of other github repos - need consistent WELL doc'ed way #6

Open clemensutschig opened 5 years ago

clemensutschig commented 5 years ago

@michaelsauter @stitakis @rattermeyer @torstenhe @tjaeschke

we make use of a few other github based repos and have to find consistent approach how we do it. Today we either curl it from the source, or we suck it down once and include it - e.g in the scala quickstarter (based on akka-quickstarter). I don't think either of this is good.

What about forking those to opendevstack - so we are in control of the release cycles...

Not urgent - but we need to get this sorted out.

rattermeyer commented 5 years ago

My basic points would be for any solution:

The version must be pinned
We must control and know the version we are using
We should keep the number of repositories under opendevstack small

Then we have the problem that we might build upon a version and patch it (in a way that cannot be easily fed upstream).

So, my proposal would be:

curl or clone / checkout a specific version if that is available upstream and we can use it without modification
fork, version and (optionally) patch, if we need to create a release version, or we need to patch an existing repo (this should be done on a specific branch)

Incorporating our fixes would then require pulling from upstream, create an new branch and rebase the patch upon that branch.

michaelsauter commented 5 years ago

@rattermeyer If I understand you correctly, I think I agree with your proposal.

IMHO pinning to a tag of another repo should be good enough - if someone really withdraws a tag then so be it. Maybe that is then a lesson to not depend on that repo any longer :)

Related, forking due to modifications should also be avoided at all costs I think - it just doesn't work well in the long run (IMHO the nodejs express quickstarter suffers from this ...).

stitakis commented 5 years ago

Hi, I think forking would be additionally necessary if we need to quickly fix something on those projects... apart from that counting that a github repo can be removed it makes sense to me to fork the opendevstack dependencies. How many do we have?