Review main Merged

90834[TASK] Check ReST rendering for commits with .rst files

Garvin Hicking CR +2 V +2 Easy +17 −0 updated 10/01/25, 20:47

Commit message

The nightlies already check the ReST rendering of the full
documentation files since #107514.

However, with a commit like #107519 it became obvious
that ReST rendering checks should better be performed
on pre-merge to avoid wrongly rendered documentation files,
which are directly published on docs.typo3.org after
merge.

The whole rendering process is a step that takes a
little while longer, so unconditionally including it
in pre-merge pipeline steps would take CI longer
than necessary.

This commit introduces pre-merge checking with a rendering
step, but only if a `*.rst` file is included in a commit.

This is done with a `rules` entry which does not allow
to be used in conjunction with `except`, which is why
the current checks are "reworded" to be put into the
`rules` entry.

Review

  • Code review CR +2 Done
    • Stefan Bürk +2
    • Garvin Hicking +1
    • Anja Leichsenring +1
  • Verified V +2 Done
    • Stefan Bürk +2
    • Oliver Klee +1
    • Garvin Hicking +1
    • Anja Leichsenring +1
    • core-ci +1 CI

Issues 2

Files 1

Review log 2437

Show 712 earlier messages
  1. Garvin Hicking uploaded patch set 1 09/29/25, 06:02

  2. Anja Leichsenring voted on patch set 1 CR +1 V +1 09/29/25, 06:07

  3. core-ci voted on patch set 1 V -1 09/29/25, 06:08 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/85679

  4. core-ci commented on patch set 1 09/29/25, 06:15 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/85679

  5. Anja Leichsenring voted on patch set 1 CR 0 V 0 09/29/25, 06:21

  6. Garvin Hicking commented on patch set 1 CR -1 09/29/25, 07:06

    This needs more love; this CI run should not have ran the docs check, but it did. Unsure why, "works on my machine" (GitLab CE 17.8.5) with a reduced set of this. Help? :-)
  7. Garvin Hicking commented on patch set 2 CR -1 V -1 09/29/25, 16:08

    Published edit on patch set 1.
  8. Garvin Hicking rebased onto patch set 3 09/29/25, 16:09

  9. core-ci voted on patch set 3 V +1 09/29/25, 16:20 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/85699

  10. core-ci voted on patch set 2 V -1 09/29/25, 16:20 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/85698

  11. Garvin Hicking commented on patch set 4 V +1 09/29/25, 17:28

    Published edit on patch set 3.
  12. core-ci voted on patch set 4 V +1 09/29/25, 17:34 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/85704

  1. Garvin Hicking commented on patch set 5 V +1 09/29/25, 18:55

    Published edit on patch set 4.
  2. core-ci voted on patch set 5 V -1 09/29/25, 18:56 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/85705

  3. Garvin Hicking commented on patch set 6 V -1 09/29/25, 19:16

    Published edit on patch set 5.
  4. core-ci voted on patch set 6 V +1 09/29/25, 19:23 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/85706

  5. Garvin Hicking abandoned the change 09/29/25, 19:26

    I can't.
  6. Stefan Bürk restored the change 09/29/25, 19:38

  7. Stefan Bürk uploaded patch set 7 V +1 09/29/25, 19:40

  8. core-ci voted on patch set 7 V -1 09/29/25, 19:41 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/85707

  9. Stefan Bürk uploaded patch set 8 V -1 09/29/25, 19:55

  10. Stefan Bürk uploaded patch set 9 09/29/25, 19:56

  11. core-ci voted on patch set 9 V -1 09/29/25, 19:57 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/85709

  12. Stefan Bürk uploaded patch set 10 V -1 09/29/25, 20:06

  13. Stefan Bürk uploaded patch set 11 09/29/25, 20:09

  14. Stefan Bürk uploaded patch set 12 09/29/25, 20:12

  15. Stefan Bürk commented on patch set 12 09/29/25, 20:16

    Backport notes: ``` $CI_COMMIT_BRANCH != "main" ``` needs to be adopted on backport to "13.4" and "12.4". However, not really sure if that prevents execution after merging. Something we will know after merging it. Usually, we use "except > refs" for this, but that does not seem to work when "rules" is used (gitlab complains with syntax error on that).
  16. core-ci voted on patch set 10 V +1 09/29/25, 20:17 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/85711

  17. core-ci voted on patch set 11 V +1 09/29/25, 20:19 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/85712

  18. core-ci voted on patch set 12 V +1 09/29/25, 20:20 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/85713

  19. Stefan Bürk commented on patch set 12 09/29/25, 20:22

    changeset 10: without rst file > not triggering documentation rendering * pre-merge: no rendering > https://git.typo3.org/typo3/CI/cms/-/pipelines/85710 changeset 11: documentation change * pre-merge: rendering > https://git.typo3.org/typo3/CI/cms/-/pipelines/85712 changeset 12: without rst file * pre-merge: no rendering > https://git.typo3.org/typo3/CI/cms/-/pipelines/85713 * nightly..: documentation rendering - in nightly always rendering is expected https://git.typo3.org/typo3/CI/cms/-/pipelines/85714

    integrity.yml:90

    Not sure if we should use `'refs/heads/<branch>'` here: `'refs/heads/main'`.
  20. core-ci commented on patch set 12 09/29/25, 20:47 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/85714

  21. Anja Leichsenring voted on patch set 12 CR +1 V +1 09/30/25, 05:41

  22. Garvin Hicking voted on patch set 12 CR +1 V +1 09/30/25, 06:06

  23. Oliver Klee voted on patch set 12 V +1 09/30/25, 06:49

  24. Stefan Bürk voted on patch set 12 CR +2 V +2 10/01/25, 20:47

  25. Stefan Bürk merged patch set 13 10/01/25, 20:47