request for hints concerning specific make and Jenkins options

[bansp]

Hi all,

This is directed at experts in the intricacies of the options provided by the Guidelines Makefile and possibly also Jenkins.
For the purpose of testing proposals developed within the LingSIG, I would love to identify the options of make that would give us:

1. P5/release/xml/tei/odd/p5.nvdl, in order to substitute it in the PIs that identify schemas in the parts of the Guidelines that we happen to be working on
2. the HTML versions of the Guidelines (including the specs and possibly, but not necessarily for now, the exemplars)
3. possibly some early testing that would signal issues before our suggestions are submitted to the Council

At the same time, I would like to avoid:

a. generating Guidelines other than "en"
b. all the zipping -- we don't need archives, we just need the artefacts (and only for "en")

Currently, I use the following for Jenkins:
make VCS=git INJENKINS=true XSL=${JENKINS_HOME}/jobs/Stylesheets-dev/lastSuccessful/archive/dist/xml/tei/stylesheet clean dist -- and that produces the .nvdl and the Guidelines, along with a heap of stuff that I don't need at all, due to which the last Jenkins run took over 1.5h... that's a bit mucho, I'd prefer something like, errm, 5 minutes, which should in theory be enough for just (1) and (2) above, without the (a) and (b).

I have tried a few combinations such as, e.g., clean validate exemplars test html-web, hoping to see the NVDL, but I would only get the Guidelines out of that, and sometimes even only the "en" Guidelines. But we need the NVDL badly, because without it, we can't work on a proposal for a new attribute class.

I have also tried invoking the dist sub-targets separately (so, e.g., dist-source dist-schema), but it looks like dist is an all or nothing target, or at least I don't know how to successfully invoke just some of its targets. And it looks like there is no negotiating with dist wrt archives -- they are produced automatically (and delay the processing hugely).

Any hints you could push my way, please?

Thanks in advance!

[sydb]

Hi @bansp! Sorry, I did not even notice this posting until @HelenaSabel gave a poke. (Thanks @HelenaSabel!)

I cannot speak about what to do within the Jenkins environment, as I have not ever done so myself. (But probably will in a month or two — we are getting our own CI server! Yay!) But here are some hints you may find helpful, not necessarily in an intelligent order.

1. p5.nvdl and p5valid.nvdl are not (to my knowledge) built, they just exist. (All the Makefile does, besides attempt to validate against them, is to copy them over to a release directory.)
2. I think clean, validate, html-web, test, & exemplars is exactly the set of targets you probably want to execute.
3. VCS=git is not really necessary, git is the default. (No harm, either.)
4. I do not think INJENKINS=true is strictly necessary when VCS=git, but I would leave it anyway. (Can’t hurt, might help, especially if someone changes the Makefile in the future expecting you to have it.)
5. Since you do not need the README files or the Guidelines in multiple languages, my instinct is to steer clear of the dist* targets. If there is something you really need in there, though (other than *.nvdl, which can just be copied), let me know, I can poke at this further.

In case it is remotely helpful, what I typically do outside the Jenkins environment is either

$ cd /path/to/TEI_repo/P5
$ time make clean validate html-web test exemplars XSL=/path/to/Stylesheets_repo

or, in order to execute within the TEIC “jenkins” Docker container

$ time sudo docker run --rm -v /path/to/TEI_repo:/TEI -v /path/to/Stylesheets_repo:/stylesheet -w /TEI/P5 -it --entrypoint=make teic/jenkins clean validate html-web test exemplars XSL=/stylesheet

I have tried adding --jobs=4 -Oline (or even --jobs=$(nproc 2>/dev/null || echo 1) -Oline), but that has failed dramatically. (I think, but am not sure, that what happens is one of the parallel jobs wants to use a directory or p5.xml that another job is supposed to have already built, but hasn’t yet.)