Merge branch 'master' into xep-0313

xsf · Sep 18, 2024 · 19b5610 · 19b5610
2 parents 17a5d23 + 37b33b9
commit 19b5610
Show file tree

Hide file tree

Showing 67 changed files with 7,049 additions and 638 deletions.
diff --git a/.github/workflows/auto-triage.yml b/.github/workflows/auto-triage.yml
@@ -0,0 +1,34 @@
+name: Triage
+on:
+  pull_request_target:
+    types:
+      - opened
+      - edited
+    branches:
+      - master
+    paths:
+      - 'xep-*.xml'
+jobs:
+  label_pr:
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+    steps:
+      - uses: awalsh128/cache-apt-pkgs-action@latest
+        with:
+          packages: libxml2-utils
+          version: cachetag1
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Copy trusted version of script
+        run: cp tools/github_auto_triage_pr.sh /tmp
+      - name: Setup PR branch locally
+        run: gh pr checkout ${{ github.event.pull_request.number }}
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GH_REPO: ${{ github.repository }}
+      - run: bash /tmp/github_auto_triage_pr.sh ${{ github.event.pull_request.number }}
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GH_REPO: ${{ github.repository }}
diff --git a/.github/workflows/xep-validation.yml b/.github/workflows/xep-validation.yml
@@ -10,13 +10,13 @@ jobs:
     runs-on: ubuntu-latest
     name: Validate any XEP changes
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
       - name: Detect changes to XEP files
         id: changed-xeps
-        uses: tj-actions/changed-files@v34
+        uses: tj-actions/changed-files@v41
         with:
           files: |
             xep-*.xml
@@ -31,5 +31,11 @@ jobs:
             if ! tools/validate-xep0001-conformance.sh "$xep"; then
               result=1
             fi
+            if [[ ${xep} == xep-* ]]; then
+              echo Checking ${xep} by invoking \"make .${xep}.check.ok\"
+              if ! make ".${xep}.check.ok"; then
+                result=1
+              fi
+            fi
           done
           exit $result
diff --git a/.gitignore b/.gitignore
@@ -75,3 +75,5 @@ Session.vim
 /tools/xeps-email.conf
 /tmp/
 /pr-worktree/
+
+.*.xml.check.ok
diff --git a/Makefile b/Makefile
@@ -1,5 +1,3 @@
-.SILENT:
-
 OUTDIR?=build
 REFSDIR?=$(OUTDIR)/refs
 EXAMPLESDIR?=$(OUTDIR)/examples
@@ -36,6 +34,7 @@ xep_pdfs=$(patsubst %.xml,$(OUTDIR)/%.pdf,$(xeps))
 xep_refs=$(patsubst xep-%.xml, $(REFSDIR)/reference.XSF.XEP-%.xml, $(xeps))
 xep_examples=$(patsubst xep-%.xml, $(EXAMPLESDIR)/%.xml, $(xeps))
 
+all_xep_check_ok=$(patsubst %.xml, .%.xml.check.ok, $(xeps))
 
 .PHONY: help
 help:
@@ -46,6 +45,7 @@ help:
 	@echo '                  refs  -  build all IETF refs'
 	@echo '                  html  -  build all XEPs'
 	@echo '            inbox-html  -  build all ProtoXEPs'
+	@echo '                 check  -  check all XEPs for errors'
 	@echo '                 clean  -  recursively unlink the build tree'
 	@echo '               preview  -  builds html whenever an XEP changes (requires inotify-tools)'
 	@echo '              examples  -  extract all examples'
@@ -82,6 +82,9 @@ refs: $(xep_refs)
 .PHONY: examples
 examples: $(xep_examples)
 
+.PHONY: check
+check: $(all_xep_check_ok)
+
 .PHONY: xep-%
 xep-%: $(OUTDIR)/xep-%.html $(REFSDIR)/reference.XSF.XEP-%.xml $(OUTDIR)/xep-%.pdf $(EXAMPLESDIR)/%.xml;
 
@@ -106,30 +109,24 @@ $(EXAMPLESDIR)/%.xml: xep-%.xml $(XMLDEPS) examples.xsl | $(EXAMPLESDIR)
 $(REFSDIR)/reference.XSF.XEP-%.xml: xep-%.xml $(XMLDEPS) ref.xsl | $(REFSDIR)
 	xsltproc --path $(CURDIR) ref.xsl "$<" > "$@" && echo "Finished building $@"
 
-$(xep_htmls): $(OUTDIR)/xep-%.html: xep-%.xml $(XMLDEPS) $(HTMLDEPS) | $(OUTDIR)
+.%.xml.check.ok: %.xml
 	xmllint --nonet --noout --noent --loaddtd --valid "$<"
-	# Check for non-data URIs
-	! xmllint --nonet --noout --noent --loaddtd --xpath "//img/@src[not(starts-with(., 'data:'))]" $< 2>/dev/null && true
+	# Check for non-data URIs, the result set of the XPath expression below should be empty
+	# Disabled for now, see
+	# https://github.com/xsf/xeps/issues/1316 and https://gitlab.gnome.org/GNOME/libxml2/-/issues/673
+	# xmllint --loaddtd --xpath "//img/@src[not(starts-with(., 'data:'))]" $< > /dev/null
+	touch $@
 
-	# Actually build the HTML
+$(xep_htmls): $(OUTDIR)/xep-%.html: xep-%.xml $(XMLDEPS) $(HTMLDEPS) | $(OUTDIR)
 	xsltproc --path $(CURDIR) --param htmlbase "$(if $(findstring inbox,$<),'../','./')" xep.xsl "$<" > "$@" && echo "Finished building $@"
 
 $(proto_xep_htmls): $(OUTDIR)/inbox/%.html: inbox/%.xml $(XMLDEPS) $(proto_HTMLDEPS) | $(OUTDIR)
-	xmllint --nonet --noout --noent --loaddtd --valid "$<"
-	# Check for non-data URIs
-	! xmllint --nonet --noout --noent --loaddtd --xpath "//img/@src[not(starts-with(., 'data:'))]" $< 2>/dev/null && true
-
-	# Actually build the HTML
 	xsltproc --path $(CURDIR) --param htmlbase "$(if $(findstring inbox,$<),'../','./')" xep.xsl "$<" > "$@" && echo "Finished building $@"
 
 $(OUTDIR)/xmpp.pdf $(OUTDIR)/xmpp-text.pdf: | $(OUTDIR)
 	cp "resources/$(notdir $@)" "$@"
 
 $(OUTDIR)/%.pdf: %.xml $(XMLDEPS) $(TEXMLDEPS)
-	xmllint --nonet --noout --noent --loaddtd --valid "$<"
-	# Check for non-data URIs
-	! xmllint --nonet --noout --noent --loaddtd --xpath "//img/@src[not(starts-with(., 'data:'))]" $< 2>/dev/null && true
-
 	xsltproc --path $(CURDIR) xep2texml.xsl "$<" > "$(@:.pdf=.tex.xml)"
 	texml -e utf8 "$(@:.pdf=.tex.xml)" "$(@:.pdf=.tex)"
 	sed -i -e 's|\([\s"]\)\([^"]http://[^ "]*\)|\1\\path{\2}|g' \