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
|
# __ __ _
# ___\ \/ /_ __ __ _| |_
# / _ \\ /| '_ \ / _` | __|
# | __// \| |_) | (_| | |_
# \___/_/\_\ .__/ \__,_|\__|
# |_| XML parser
#
# Copyright (c) 2021-2026 Sebastian Pipping <sebastian@pipping.org>
# Copyright (c) 2023 Joyce Brum <joycebrum@google.com>
# Licensed under the MIT license:
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to permit
# persons to whom the Software is furnished to do so, subject to the
# following conditions:
#
# The above copyright notice and this permission notice shall be included
# in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
# NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
# DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
# USE OR OTHER DEALINGS IN THE SOFTWARE.
name: Ensure well-formed and valid XML
on:
pull_request:
push:
schedule:
- cron: '0 2 * * 5' # Every Friday at 2am
workflow_dispatch:
permissions:
contents: read
jobs:
checks:
name: Ensure well-formed and valid XML
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
- name: Install build dependencies
env:
tidy_version: 5.8.0
run: |-
set -x
sudo apt-get update
sudo apt-get install --yes --no-install-recommends -V \
docbook \
libxml2-utils \
moreutils \
w3c-sgml-lib
# NOTE: Ubuntu 24.04 has tidy 5.6.0 while we need more recent tidy 5.8.0
wget --progress=dot:giga "https://github.com/htacg/tidy-html5/releases/download/${tidy_version}/tidy-${tidy_version}-Linux-64bit.deb"
sudo apt-get install --yes "./tidy-${tidy_version}-Linux-64bit.deb"
- name: Enforce clean XML
run: |
tidy_args=(
--indent 1
--tidy-mark no
--vertical-space yes
--wrap 90
--write-back yes
)
set -x -o pipefail
# Re-indent XHTML
tidy "${tidy_args[@]}" expat/doc/reference.html
# Drop trailing whitespace
sed 's, \+$,,' -i.bak expat/doc/reference.html
# Replace leading tabs by spaces
expand -i -t 2 expat/doc/xmlwf.xml | sponge expat/doc/xmlwf.xml
git -c color.ui=yes diff --exit-code # i.e. show diff and fail CI if there is a diff
- name: Ensure well-formed and valid XML
run: |
set -x
# Target offline validation rather than online (for robust CI)
sed 's,http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd,file:///usr/share/sgml/docbook/dtd/4.2/docbookx.dtd,' -i expat/doc/xmlwf.xml
sed 's,http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd,file:///usr/share/xml/w3c-sgml-lib/schema/dtd/REC-xhtml1-20020801/xhtml1-strict.dtd,' -i expat/doc/reference.html
# We're using unshare(1) to take internet access away forcefully
# so that we'll notice whenever our all-offline validation stops being all-offline
unshare --map-root-user --net -- xmllint --nonet --noout --valid expat/doc/reference.html
unshare --map-root-user --net -- xmllint --nonet --noout --valid expat/doc/xmlwf.xml
|
