Repository navigation
122 lines (115 loc) · 5.67 KB
/
Copy pathLaTeXDocumentation.yml
File metadata and controls
122 lines (115 loc) · 5.67 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# ==================================================================================================================== #
# Authors: #
# Patrick Lehmann #
# #
# ==================================================================================================================== #
# Copyright 2020-2026 The pyTooling Authors #
# #
# Licensed under the Apache License, Version 2.0 (the "License"); #
# you may not use this file except in compliance with the License. #
# You may obtain a copy of the License at #
# #
# http://www.apache.org/licenses/LICENSE-2.0 #
# #
# Unless required by applicable law or agreed to in writing, software #
# distributed under the License is distributed on an "AS IS" BASIS, #
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. #
# See the License for the specific language governing permissions and #
# limitations under the License. #
# #
# SPDX-License-Identifier: Apache-2.0 #
# ==================================================================================================================== #
name: LaTeX Documentation
on:
workflow_call:
inputs:
ubuntu_image_version:
description: 'Ubuntu image version.'
required: false
default: '26.04'
type: string
latex_artifact:
description: 'Name of the LaTeX documentation artifact.'
required: true
type: string
document:
description: 'LaTeX root document without *.tex extension.'
required: true
type: string
miktex_image:
description: 'Name of MiKTeX docker image.'
required: false
default: 'pytooling/miktex:sphinx'
type: string
update:
description: 'Update MiKTeX packages.'
required: false
default: 'false'
type: string
processor:
description: 'Name of the used LaTeX processor.'
required: false
default: 'lualatex'
type: string
halt-on-error:
description: 'Halt on first error, otherwise continue as long as possible.'
required: false
default: 'true'
type: string
pdf_artifact:
description: 'Name of the PDF documentation artifact.'
required: false
default: ''
type: string
can-fail:
description: 'Translation from LaTeX to PDF may fail.'
required: false
default: 'false'
type: string
jobs:
PDFDocumentation:
name: 📓 Converting LaTeX Documentation to PDF
runs-on: "ubuntu-${{ inputs.ubuntu_image_version }}"
continue-on-error: ${{ inputs.can-fail == 'true' }}
container:
image: ${{ inputs.miktex_image }}
steps:
- name: 📥 Download artifacts '${{ inputs.latex_artifact }}' from 'SphinxDocumentation' job
uses: pyTooling/download-artifact@v8
with:
name: ${{ inputs.latex_artifact }}
path: latex
investigate: 'true'
- name: ⚙️ Update
if: inputs.update == 'true'
run: |
printf -- "Update package database (miktex --admin packages update-package-database) ...\n"
sudo miktex --admin packages update-package-database
printf -- "Update packages (miktex --admin packages update) ...\n"
sudo miktex --admin packages update
printf -- "Update filename database (initexmf --admin --updatefndb) ...\n"
sudo initexmf --admin --update-fndb
printf -- "DONE\n"
- name: 📖 Build LaTeX document using 'pytooling/miktex:sphinx'
if: inputs.pdf_artifact != ''
run: |
set -o pipefail
if [[ "${{ inputs.halt-on-error }}" == "true" ]]; then
HALT_ON_ERROR="--halt-on-error"
fi
cd latex
latexmk \
--${{ inputs.processor }} \
--interaction=nonstopmode \
--file-line-error \
${HALT_ON_ERROR} \
"${{ inputs.document }}.tex" | filter.latexmk.sh
- name: 📤 Upload 'PDF Documentation' artifact
uses: pyTooling/upload-artifact@v7
if: inputs.pdf_artifact != ''
with:
name: ${{ inputs.pdf_artifact }}
working-directory: latex
path: ${{ inputs.document }}.pdf
if-no-files-found: error
retention-days: 1