Review main Abandoned

75287[TASK] Ensure commit message contains needed commands

Stefan Bürk CR 0 V 0 Normal +101 −0 updated 07/26/22, 17:58

Commit message

This patch adds an integration test script to validate,
if commit message containes mentioning of used command
for reconizable actions.

The scripts starts with phpstan baseline related check
first, but may be extendend for composer related commands.

Script is added as integration test to ci. Manual invoking
can be done with:

> Build/Scripts/runTests.sh -s checkCommitMessageForCommands

Review

  • Code review CR 0
  • Verified V 0

Issues 1

Files 4

Review log 1624

  1. Stefan Bürk uploaded patch set 1 07/25/22, 23:22

  2. core-ci voted on patch set 1 V +1 07/25/22, 23:29 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/29528

  3. Stefan Bürk uploaded patch set 2 07/25/22, 23:33

  4. core-ci voted on patch set 2 V +1 07/25/22, 23:40 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/29529

  5. Simon Schaufelberger commented on patch set 2 CR -1 07/26/22, 02:05

    an

    checkCommitMessageForCommands.sh:7

    typo

    checkCommitMessageForCommands.sh:8

    additionally

    checkCommitMessageForCommands.sh:29

    there is no need for ./. can also be without.
  6. Stefan Bürk uploaded patch set 3 07/26/22, 03:44

  7. Stefan Bürk commented on patch set 3 07/26/22, 03:44

    Reply

    Done

    checkCommitMessageForCommands.sh:7 Reply

    Done

    checkCommitMessageForCommands.sh:8 Reply

    Done

    checkCommitMessageForCommands.sh:29 Reply

    Done
  8. Stefan Bürk updated the commit message in patch set 4 07/26/22, 03:45

  9. Stefan Bürk uploaded patch set 5 07/26/22, 03:47

  10. Stefan Bürk uploaded patch set 6 07/26/22, 03:48

  11. Stefan Bürk commented on patch set 6 07/26/22, 03:51

    Generic * PatchSet 3 pushed to incorporate comments from Simon Schaufelberger. Pushed two patchset which should explictly fail: * PatchSet 4: Used command in commit message without need * PatchSet 5: Missing mentioning used command in commit message PatchSet 6 was to revert / cleanup tests.
  12. core-ci voted on patch set 3 V +1 07/26/22, 03:53 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/29533

  13. Stefan Bürk uploaded patch set 7 07/26/22, 03:55

  14. Stefan Bürk commented on patch set 7 07/26/22, 03:58

    Reply

  15. core-ci voted on patch set 6 V -1 07/26/22, 03:59 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/29536

  16. core-ci voted on patch set 4 V -1 07/26/22, 04:00 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/29534

  17. Stefan Bürk uploaded patch set 8 07/26/22, 04:01

  18. core-ci voted on patch set 7 V -1 07/26/22, 04:02 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/29537

  19. core-ci voted on patch set 5 V -1 07/26/22, 04:05 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/29535

  20. core-ci voted on patch set 8 V +1 07/26/22, 04:08 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/29538

  21. Christian Kuhn commented on patch set 8 07/26/22, 17:14

    unsure if adding this as hard rule is really necessary.
  22. Oliver Klee commented on patch set 8 07/26/22, 17:37

    checkCommitMessageForCommands.sh:29

    I propose we remove the "> " part from the check. Then my commit message in the past (which contain "> ./Build/…" wouldn't be flagged. :-) Or we could change the regexp to optionally also accept "> ./Build/…". (I'd also be okay with keeping it the way it is, but would prefer the check to allow the other valid format as well in order to reduce false positives.)
  23. Stefan Bürk commented on patch set 8 07/26/22, 17:55

    Reply

    Rethought this. Ack. At least we should postulate and communicate it as a hardrule with a "defined" sytax before adding a test.

    checkCommitMessageForCommands.sh:29 Reply

    Rethought this. At least we should postulate and communicate it as a hardrule with a "defined" sytax before adding a test. Just for answering: Used "> " as a prefix to differenciate as "usages" to "name" it somehow instead, for a patch who is "changing" that command etc. If we do this, we should have a simply defined and prior communicated sytax, avoiding "a bunch of variations to support" to keep it simple. Anyway, will abandon this patch.
  24. Stefan Bürk abandoned the change 07/26/22, 17:58