Jenkins Pipeline for Manual
ClosedPublic
Actions

Authored by apt-ghetto on Oct 18 2020, 12:11 PM.

Details

Reviewers

lynorian
tsimonq2
teward

Maniphest Tasks

T109: Manual as PDF

Commits

rMANUALf7084ae1e48d: Jenkins Pipeline for Manual

Summary

Set up a Jenkins pipeline to build the manual as PDF:

Add a Dockerfile to create a Focal Fossa build environment
Add a Jenkinsfile for the Manual pipeline
Publish the PDF

Due to unicode characters in the source, LaTeX fails to build:

Changed the engine to xelatex
Added some LaTeX configurations for the PDF build

Ref T109

Test Plan

Setup Jenkins

1.1 Create a new Pipeline
1.1.1 Definition => Pipeline script from SCM
1.1.1 SCM => Git
1.1.1 Repositories => https://phab.lubuntu.me/source/manual/
1.2. Install plugins
1.2.1 Docker plugin and Docker Pipeline plugin
1.2.2 HTML Publisher plugin

Install Docker on the Jenkins server
Manually start the job
Check, that there is a "Lubuntu Manual" link in the Job view, when the build was successful

Diff Detail

Repository

rMANUAL Lubuntu Manual

Lint

Automatic diff as part of commit; lint not applicable.

Unit

Automatic diff as part of commit; unit tests not applicable.

Event Timeline

apt-ghetto requested review of this revision.Oct 18 2020, 12:11 PM

apt-ghetto created this revision.

apt-ghetto retitled this revision from Jenkins Pipeline for Manual Ref T109 to Jenkins Pipeline for Manual.Oct 18 2020, 12:42 PM

apt-ghetto edited the summary of this revision. (Show Details)

apt-ghetto added a task: T109: Manual as PDF.

Harbormaster completed remote builds in B212: Diff 302.Oct 19 2020, 7:12 PM

One other question I have does this using xelatex mean any different system packages need to be installed on the manual.

In D102#2179, @lynorian wrote:

One other question I have does this using xelatex mean any different system packages need to be installed on the manual.

To create a PDF the source files are first converted into LaTeX source files. To create HTML, as far as I know, you don't need the LaTeX engine and you should not be affected.

The 'xetex' engine is part of 'texlive-xetex', which is a dependency of 'texlive-formats-extra'. If you have installed the needed dependencies as listed in the README.md file (and in the Dockerfile), you should be able to create a PDF with make latexpdf.

Merging into the manual and creating the job. I'll follow up on the task shortly.

This revision is now accepted and ready to land.Oct 28 2020, 6:01 AM

Closed by commit rMANUALf7084ae1e48d: Jenkins Pipeline for Manual (authored by apt-ghetto, committed by tsimonq2). · Explain WhyOct 28 2020, 6:47 AM

This revision was automatically updated to reflect the committed changes.

tsimonq2 added a commit: rMANUALf7084ae1e48d: Jenkins Pipeline for Manual.