Skip to content

CI: Add docbook-cs linting - #5524

Merged
jordikroon merged 1 commit into
php:masterfrom
jordikroon:feature/docbook-cs
Jun 13, 2026
Merged

jordikroon merged 1 commit into
php:masterfrom
jordikroon:feature/docbook-cs

Conversation

@jordikroon

@jordikroon jordikroon commented Apr 29, 2026 •

Copy link
Copy Markdown
Member

As announced here: https://news-web.php.net/php.doc/969388652
See for test implementation: #5510

The sniffer includes:

This also makes check-whitespaces.xml obsolete, as the sniffer will check for that as well.

The sniffer also covers #5445

  • <simpara> should be used instead of <para>
  • Exception or error class names wrapped in <classname> that should use <exceptionname> instead.
  • Whitespace checks (.github/workflows/check-whitespace.yml became obsolete)
  • Ensuring that when an element has both xml and xmlns attributes or xmlns variants, xml appears first (covers Add CI warning for xml:id before xmlns attribute order #5445)

@TimWolla TimWolla left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some remarks for the workflow definition. Didn't look at the tool itself, but the premise sounds good to me.

Comment thread .github/workflows/docbook-cs.yml Outdated
Comment thread .github/workflows/docbook-cs.yml Outdated
Comment thread .github/workflows/docbook-cs.yml Outdated
Comment thread .github/workflows/docbook-cs.yml Outdated
Comment thread .github/workflows/docbook-cs.yml Outdated
Comment thread .github/workflows/docbook-cs.yaml
@TimWolla
TimWolla requested a review from Girgias April 29, 2026 19:15

@TimWolla TimWolla left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some more quick GHA comments. Will need to think about the git / checkout usage more at a later point.

Comment thread .github/workflows/docbook-cs.yml Outdated
Comment thread .github/workflows/docbook-cs.yaml
Comment thread .github/workflows/docbook-cs.yml Outdated
Comment thread .github/workflows/docbook-cs.yml Outdated
Comment thread docbookcs.xml Outdated
@jordikroon

Copy link
Copy Markdown
Member Author

I am planning to merge Docbook-cs in a few days as all feedback has been addressed. Please let me know if there are comments, objections or concerns regarding this new tool. So to say any feedback is welcome.

Comment thread .github/workflows/docbook-cs.yml Outdated
Comment thread .github/workflows/docbook-cs.yml Outdated
Comment thread .github/workflows/docbook-cs.yml Outdated
Comment thread .github/workflows/docbook-cs.yml Outdated
Comment thread .github/workflows/docbook-cs.yml Outdated
@jordikroon
jordikroon force-pushed the feature/docbook-cs branch 2 times, most recently from a3acc00 to 281502f Compare June 1, 2026 19:20
Comment thread .github/workflows/docbook-cs.yml Outdated
Comment thread .github/workflows/docbook-cs.yml Outdated
@jordikroon
jordikroon force-pushed the feature/docbook-cs branch from 723d519 to 257f90a Compare June 9, 2026 17:48
@jordikroon
jordikroon merged commit 23e4fb4 into php:master Jun 13, 2026
4 of 5 checks passed
@jordikroon
jordikroon deleted the feature/docbook-cs branch June 13, 2026 20:43
mmalferov pushed a commit to mmalferov/doc-en that referenced this pull request Jun 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants