From 06d0d2005308fd7a16c89cd093bd4af9a1007334 Mon Sep 17 00:00:00 2001 From: jrfnl Date: Tue, 12 Nov 2024 12:07:18 +0100 Subject: [PATCH 1/2] GH Actions/basics: add check for valid XML docs Verify basic well-formedness of the XML docs. --- .github/workflows/validate.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/workflows/validate.yml b/.github/workflows/validate.yml index 4bca98b4d5..aec000b2f5 100644 --- a/.github/workflows/validate.yml +++ b/.github/workflows/validate.yml @@ -72,6 +72,10 @@ jobs: diff -B ./src/Standards/Squiz/ruleset.xml <(xmllint --format "./src/Standards/Squiz/ruleset.xml") diff -B ./src/Standards/Zend/ruleset.xml <(xmllint --format "./src/Standards/Zend/ruleset.xml") + # Validate the basic well-formedness of the Documentation XML files. + - name: Validate documentation XML + run: xmllint --noout ./src/Standards/*/Docs/*/*Standard.xml + yamllint: name: 'Lint Yaml' # Don't run the cronjob in this workflow on forks. From 12c11ba01c8cd1fe5120f295e86944ad1d3c9e78 Mon Sep 17 00:00:00 2001 From: jrfnl Date: Tue, 12 Nov 2024 12:00:34 +0100 Subject: [PATCH 2/2] Docs: fix up two XML docs * The `HereNowdocIdentifierSpacing` one contained unescaped special chars in an attribute (oops). * The `SpreadOperatorSpacingAfter` line length did not conform (not found via the new CI check, but even so). --- .../Docs/WhiteSpace/HereNowdocIdentifierSpacingStandard.xml | 4 ++-- .../Docs/WhiteSpace/SpreadOperatorSpacingAfterStandard.xml | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/Standards/Generic/Docs/WhiteSpace/HereNowdocIdentifierSpacingStandard.xml b/src/Standards/Generic/Docs/WhiteSpace/HereNowdocIdentifierSpacingStandard.xml index 17cad50f69..66759bf5ba 100644 --- a/src/Standards/Generic/Docs/WhiteSpace/HereNowdocIdentifierSpacingStandard.xml +++ b/src/Standards/Generic/Docs/WhiteSpace/HereNowdocIdentifierSpacingStandard.xml @@ -5,14 +5,14 @@ ]]> - + << some text EOD; ]]> - + <<< END some text diff --git a/src/Standards/Generic/Docs/WhiteSpace/SpreadOperatorSpacingAfterStandard.xml b/src/Standards/Generic/Docs/WhiteSpace/SpreadOperatorSpacingAfterStandard.xml index 7663b0c437..558bebfac0 100644 --- a/src/Standards/Generic/Docs/WhiteSpace/SpreadOperatorSpacingAfterStandard.xml +++ b/src/Standards/Generic/Docs/WhiteSpace/SpreadOperatorSpacingAfterStandard.xml @@ -25,7 +25,7 @@ function bar(... $spread) { ); bar( - [... $foo ],.../*comment*/array_values($keyedArray) + [... $foo ],.../*@*/array_values($keyed) ); } ]]>