Review main Merged

86407[TASK] Allow sets to be excluded from site configuration GUI

Benjamin Franzke CR +2 V +2 Normal +69 −17 updated 10/14/24, 13:51

Commit message

Sets that are intended for code-wise structuring only and should
not be referenced by integrators via site configuration directly
can now be excluded from the site configuration GUI by marking
them as `hidden`.

config.yaml:
  name: foo/bar
  hidden: true

Integrators can additionally choose to mark external sets as
hidden via User TSConfig, e.g. in Configuration/user.tsconfig:

  options.sites.hideSets := addToList(typo3/fluid-styled-content)

This might be used if only a certain subset of site sets
should be available in the backend UI.

Review

  • Code review CR +2 Done
    • Andreas Kienast +2
    • Benjamin Kott +1
  • Verified V +2 Done
    • Andreas Kienast +2
    • Benjamin Kott +1
    • core-ci +1 CI

Issues 1

Files 5

Review log 1926

Show 1 earlier messages
  1. Benjamin Franzke uploaded patch set 1 10/03/24, 13:27

  1. core-ci voted on patch set 1 V +1 10/03/24, 13:34 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/67009

  2. Garvin Hicking commented on patch set 1 10/03/24, 14:20

    Some ideas that might fit for an easier understanding: - internal - restricted - sealed - protected - locked and a few more off-the-track: - concealed - contained - vaulted IMO "internal" is an established one...?
  3. Garvin Hicking commented on patch set 1 10/03/24, 14:48

    Reply

    (or maybe simply descriptive: excludedFromGui)
  4. Benjamin Franzke uploaded patch set 2 V +1 10/03/24, 21:49

  5. Benjamin Franzke commented on patch set 2 10/03/24, 21:49

    Reply

    thx, I think I'll go with `hidden` for simplicity and introduce an additional user tsconfig setting `options.hideSets` (to match `options.hideModules`) – or maybe `options.hideSiteSets` or `options.sites.hideSets`.
  6. core-ci voted on patch set 2 V +1 10/03/24, 22:05 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/67034

  7. Benjamin Franzke uploaded patch set 3 V +1 10/04/24, 05:35

  8. core-ci voted on patch set 3 V +1 10/04/24, 05:50 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/67051

  9. Garvin Hicking commented on patch set 4 V +1 10/04/24, 05:54

    Published edit on patch set 3.
  10. Garvin Hicking commented on patch set 4 10/04/24, 06:08

    (I rephrased a small sentences in the changelog, please check if I didn't mangle your intent)

    TcaSiteSetCollector.php:46

    How about extracting a method for getSelectedSets? That would also allow to add a function test for it...?
  11. core-ci voted on patch set 4 V +1 10/04/24, 06:11 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/67052

  12. Garvin Hicking commented on patch set 4 CR +1 10/04/24, 06:12

    TcaSiteSetCollector.php:46 Reply

    Thinking on it, nvm, can be done in .1 later, not wanting to add workload here.
  13. Benjamin Franzke uploaded patch set 5 CR +1 V +1 10/04/24, 06:42

  14. Benjamin Franzke uploaded patch set 6 10/04/24, 06:45

  15. Benjamin Franzke commented on patch set 6 10/04/24, 06:45

    Reply

    thx (overpushed by accident, but restored now)
  16. Mathias Brodala commented on patch set 6 10/04/24, 06:48

    Feature-103437-IntroduceSiteSets.rst:134

    This sounds like TYPO3 logic: add something to remove it somewhere. ;-) If feasible, an "options.sites.availableSets" option would be better which is populated from the sets. Then "removeFromList()" can be used to make this feature self-explanatory.
  17. Benjamin Franzke rebased onto patch set 7 10/04/24, 06:55

  18. core-ci voted on patch set 6 V +1 10/04/24, 07:01 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/67055

  19. core-ci voted on patch set 7 V +1 10/04/24, 07:15 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/67057

  20. Benjamin Franzke commented on patch set 7 10/04/24, 10:09

    Feature-103437-IntroduceSiteSets.rst:134 Reply

    I did this to conform to existing settings like `hideModules` and I don't like the implication of an option named `options.sites.availableSets` – that sounds (in terms of "self-explanatory") like a set always has to be registered manually in here. Sorry, I don't want this. (I'd be fine with an additional allow-list instead of a deny list, `hideSets` should actually be fine IMO).
  21. Benjamin Franzke rebased onto patch set 8 V +1 10/04/24, 12:57

  22. core-ci voted on patch set 8 V +1 10/04/24, 13:20 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/67091

  23. Benjamin Kott voted on patch set 8 CR +1 V +1 10/14/24, 13:34

  24. Andreas Kienast voted on patch set 8 CR +2 V +2 10/14/24, 13:50

  25. Andreas Kienast merged patch set 9 10/14/24, 13:51