[oXygen-user] Git submodules in frameworks

Christophe Marchand cmarchand at oxiane.com
Mon Nov 9 16:49:27 CST 2020


Hum... Gerrit uses a lot submodules in his/their product, with success. 
In my opinion, it's not enough. There is nothing that avoid you to set 
your submodule reference to a branch under developement.

I prefer using a dependency mecanism, and a release system. Once a 
library is validated, you produce a release, wich is a deliverable 
recorded into an artifact repository. Your programs declare a dependency 
to this artifact, and it's resolved dynamically, and recursively. At 
least two talks exists on this, one from [1]l-acoustics, the other from 
[2]ELS, the first one on a document point-of-view, the second one on a 
code point-of-view.

Building a deliverable, and storing it into an artifact repository 
allows you to add a lot of checks in the build process, [3]unit-tests, 
[4]quality-gate, and so on... and grows your libraries to a higher 
level. You can do the same with git submodules for dependency 
resolution, but you miss the whole Continuous Integration process.

You'd better build your framework, deploy it to an artifact repository 
(a basic file web server), and then configure oXygen to get this 
framework from this location.

Hope this helps,
Christophe

[1] 
https://www.oxygenxml.com/events/2018/dita-ot_day.html#DITA_gradle_and_git
[2] https://www.xmlprague.cz/day2-2018/#cm
[3] https://github.com/xspec/xspec/wiki
[4] https://www.xmlprague.cz/day3-2019/#sonar

Le 09/11/2020 à 21:02, Wendell Piez a écrit :
> oXygen friends,
>
> Frameworks in oXygen make up a fantastic feature set. Git is a very 
> nice way to manage versioning in a distributed way.
>
> I am looking at making a framework that uses libraries from Github. 
> Presently I am thinking of pointing to those libraries from my 
> framework as git submodules and maintaining them that way.
>
> Is this a bad idea? If my framework is eventually distributed from 
> Github, is this likely to be nice, or not so nice?
>
> Thanks - a git user for years now, but still a novice --
> Cheers, Wendell
>
> -- 
> ...Wendell Piez... ...wendell -at- nist -dot- gov...
> ...wendellpiez.com... ...pellucidliterature.org... ...pausepress.org...
> ...github.com/wendellpiez. <http://github.com/wendellpiez.>.. 
> ...gitlab.coko.foundation/wendell...
>
> _______________________________________________
> oXygen-user mailing list
> oXygen-user at oxygenxml.com
> https://www.oxygenxml.com/mailman/listinfo/oxygen-user
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://www.oxygenxml.com/pipermail/oxygen-user/attachments/20201109/6e0738f7/attachment.html>


More information about the oXygen-user mailing list