Merge pull request #56 from youwe-petervanderwal/feat/conventional-commit-message

youwe-petervanderwal · web-flow · commit 75981a016bb3 · 2025-10-27T12:51:05.000+01:00
feat: validate commit messages are according conventional commits guidelines
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -21,6 +21,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Pimcore PHPStan default config.
 - Pimcore PHP Mess Detector default config.
 - Added constraint for `PHPMD`, since Magento 2.4.8 requires version `3.x-dev`. 
+- Commit Message validator to validate the commit message adheres to the 
+  [Conventional Commit Message structure](https://cheatography.com/albelop/cheat-sheets/conventional-commits/)
+  and that the commit message contains a Jira ticket number it relates to.
 
 ### Changed
 - [BREAKING] The composer.json configurations `config.youwe-testing-suite.type` and `config.mediact-testing-suite.type`
diff --git a/MIGRATION.md b/MIGRATION.md
@@ -80,7 +80,21 @@ As alternative, you can revert your project to the old behaviour by setting the
 parameter in your `grumphp.yml`. Please read [Why you should always analyse the whole project](https://phpstan.org/blog/why-you-should-always-analyse-whole-project)
 before reverting to the old behaviour.
 
-### 4. Sanity checks
+### 4. Commit Message Jira project configuration
+
+Configure the Jira project(s) for which ticket numbers should be included in your commit messages.
+Add the following configuration to the `grumphp.yml`:
+
+```yaml
+parameters:
+  # Configure your Jira Project codes as pipe-separated value:
+  git_commit_message.jira_projects: 'PIMBBBBABC|MAGBBBBDEF|P012345'
+
+  # Or to disable the requirement for a Jira ticket number in the commit message:
+  # git_commit_message.jira_matcher: '/.*/'
+```
+
+### 5. Sanity checks
 Check the following
 
 1. The PHPCS file exists in your project root and points to the correct ruleset
@@ -90,7 +104,7 @@ configuration in youwe/testing-suite
 3. Run `ddev exec grumphp run` or `vendor/bin/grumphp run`
 4. Your git commit hook still functions as expected
 
-### 5. Refactor and/or update/regenerate exclusion rules
+### 6. Refactor and/or update/regenerate exclusion rules
 Some rulesets will have changed. In a general sense, the rulesets are less
 strict compared to what they were before.
 
diff --git a/README.md b/README.md
@@ -46,6 +46,7 @@ or if no explicit setting was found for the Testing Suite, via
 ## Included analysis tools
 
 - [Git blacklist](docs/components/git-blacklist.md)
+- [Git commit message](docs/components/git-commit-message.md)
 - [Composer file validation](docs/components/composer.md)
 - [JSON Lint](docs/components/jsonlint.md)
 - [YamlLint](docs/components/yamllint.md)
diff --git a/config/default/grumphp.yml b/config/default/grumphp.yml
@@ -79,6 +79,33 @@ parameters:
   git_blacklist.match_word: true
   git_blacklist.ignore_patterns: []
 
+  git_commit_message.type_scope_conventions:
+    types:
+      - build
+      - chore
+      - ci
+      - cleanup
+      - config
+      - docs
+      - feat
+      - fix
+      - merge
+      - perf
+      - refactor
+      - release
+      - revert
+      - style
+      - test
+  git_commit_message.enforce_capitalized_subject: false # Not to be used in combination with type_scope_conventions
+  git_commit_message.max_body_width: 72 # To disable this setting, use a value of 0
+  git_commit_message.max_subject_width: 72
+  # The available Jira Projects should be configured in your project repository. Multiple projects can be configured pipe-separated
+  git_commit_message.jira_projects: 'YOU_SHOULD_CONFIGURE_YOUR|JIRA_PROJECT_CODES|IN_YOUR_GRUMP_YML'
+  git_commit_message.jira_matcher: '/\n.+ (%git_commit_message.jira_projects%)-\d+/'
+  git_commit_message.matchers:
+    'Must contain JIRA issue number within the message body (e.g. "Resolves PROJECT-1234")': '%git_commit_message.jira_matcher%'
+  git_commit_message.case_insensitive: false
+
 grumphp:
   ascii:
     failed: ~
@@ -107,6 +134,14 @@ grumphp:
       match_word: '%git_blacklist.match_word%'
       ignore_patterns: '%git_blacklist.ignore_patterns%'
 
+    git_commit_message:
+        enforce_capitalized_subject: '%git_commit_message.enforce_capitalized_subject%'
+        type_scope_conventions: '%git_commit_message.type_scope_conventions%'
+        max_body_width: '%git_commit_message.max_body_width%'
+        max_subject_width: '%git_commit_message.max_subject_width%'
+        matchers: '%git_commit_message.matchers%'
+        case_insensitive: '%git_commit_message.case_insensitive%'
+
     xmllint:
       load_from_net: '%xmllint.load_from_net%'
       x_include: '%xmllint.x_include%'
diff --git a/docs/components/git-commit-message.md b/docs/components/git-commit-message.md
@@ -0,0 +1,30 @@
+# Git Commit Message
+
+The default configuration will validate the commit message adheres to the [Conventional Commit Message structure](https://cheatography.com/albelop/cheat-sheets/conventional-commits/)
+and that the commit message body contains a Jira ticket number it relates to.
+
+## Available configuration
+
+The following configuration can be changed in your project's `grumphp.yml`:
+
+```yaml
+parameters:
+    git_commit_message.type_scope_conventions:
+        # Change list of allowed types, use `git_commit_message.type_scope_conventions: {}` to disable this feature
+        types:
+            - build
+            - chore
+            - feat
+    git_commit_message.enforce_capitalized_subject: false
+    git_commit_message.max_body_width: 72 # To disable this setting, use a value of 0
+    git_commit_message.max_subject_width: 72
+    # Configure your Jira Project codes as pipe-separated value
+    git_commit_message.jira_projects: 'JIRAPROJ|OTHERPROJ'
+    # Override if you want to change the Jira matcher, use `git_commit_message.jira_matcher: '/.*/` to disable it completely 
+    git_commit_message.jira_matcher: '/\n.+ (%git_commit_message.jira_projects%)-\d+/'
+    # Configure custom matchers, make sure to include the Jira matcher if you want to add more custom matchers
+    git_commit_message.matchers:
+        'Must contain JIRA issue number within the message body (e.g. "Resolves PROJECT-1234")': '%git_commit_message.jira_matcher%'
+    git_commit_message.case_insensitive: false
+
+```
diff --git a/grumphp.yml b/grumphp.yml
@@ -10,6 +10,9 @@ parameters:
     - /^pdepend.xml$/
     - /^templates/
 
+  # Disable requirement for Jira ticket number in the commit message
+  git_commit_message.jira_matcher: '/.*/'
+
 grumphp:
   # Disable ddev wrapper when running grumphp of testing-suite itself.
   # Temp until testing-suite development is also wrapped by ddev, which is on the roadmap
diff --git a/templates/files/default/grumphp.yml b/templates/files/default/grumphp.yml
@@ -1,2 +1,9 @@
 imports:
-  - resource: 'vendor/youwe/testing-suite/config/default/grumphp.yml'
+  - resource: 'vendor/youwe/testing-suite/config/default/grumphp.yml'
+
+parameters:
+  # Configure your Jira Project codes as pipe-separated value:
+  # git_commit_message.jira_projects: 'PIMBBBBABC|MAGBBBBDEF|P012345'
+
+  # Or to disable the requirement for a Jira ticket number in the commit message:
+  # git_commit_message.jira_matcher: '/.*/'
diff --git a/templates/files/magento2/grumphp.yml b/templates/files/magento2/grumphp.yml
@@ -0,0 +1,9 @@
+imports:
+  - resource: 'vendor/youwe/testing-suite/config/magento2/grumphp.yml'
+
+parameters:
+  # Configure your Jira Project codes as pipe-separated value:
+  # git_commit_message.jira_projects: 'PIMBBBBABC|MAGBBBBDEF|P012345'
+
+  # Or to disable the requirement for a Jira ticket number in the commit message:
+  # git_commit_message.jira_matcher: '/.*/'
diff --git a/templates/files/pimcore/grumphp.yml b/templates/files/pimcore/grumphp.yml
@@ -8,6 +8,12 @@ parameters:
                     # - For Pimcore 10.4 till 10.x: suggest to use level 5 maximum
                     # - For Pimcore 10.0 till 10.3.x: suggest to use level 4 maximum
 
+#  Configure your Jira Project codes as pipe-separated value:
+#  git_commit_message.jira_projects: 'PIMBBBBABC|MAGBBBBDEF|P012345'
+
+#  Or to disable the requirement for a Jira ticket number in the commit message:
+#  git_commit_message.jira_matcher: '/.*/'
+
 #  securitychecker.allow_list:
 #    - CVE-2002-0121 # Add a jira ticket indicating when this vulnerability will be fixed (update/upgrade will be
                      #    performed). Within that ticket explain this (new) vulnerability.
diff --git a/templates/mapping/project/magento2 b/templates/mapping/project/magento2
@@ -1,3 +1,4 @@
+{magento2/,}grumphp.yml
 {magento2/,}phpcs.xml
 {magento2/,}phpmd.xml
 {magento2/,}phpstan.neon

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+{magento2/,}grumphp.yml`
`1`	`2`	`{magento2/,}phpcs.xml`
`2`	`3`	`{magento2/,}phpmd.xml`
`3`	`4`	`{magento2/,}phpstan.neon`