feat: Submodule commit processing

.github/fixtures/test-from-context-does-not-discard-fields/context.json

@@ -375,13 +375,15 @@
       "timestamp": 0,
       "previous": null,
       "repository": null,
+      "submodule_commits": {},
       "extra": null,
       "github": { "contributors": [] },
       "gitlab": { "contributors": [] },
       "gitea": { "contributors": [] },
       "bitbucket": { "contributors": [] }
     },
     "repository": "/path/to/repository",
+    "submodule_commits": {},
     "extra": null,
     "github": { "contributors": [] },
     "gitlab": { "contributors": [] },

.github/fixtures/test-from-context/context.json

@@ -160,6 +160,7 @@
             "timestamp": 1649201112,
             "previous": null,
             "repository": "/home/johndoe/repo/",
+            "submodule_commits": {},
             "github": {
                 "contributors": []
             },
@@ -174,6 +175,7 @@
             }
         },
         "repository": "/home/johndoe/repo/",
+        "submodule_commits": {},
         "github": {
             "contributors": []
         },
@@ -449,6 +451,7 @@
             "timestamp": 1649201110,
             "previous": null,
             "repository": "/home/johndoe/repo/",
+            "submodule_commits": {},
             "github": {
                 "contributors": []
             },
@@ -466,6 +469,7 @@
             "note": "This is so awesome!"
         },
         "repository": "/home/johndoe/repo/",
+        "submodule_commits": {},
         "github": {
             "contributors": []
         },
@@ -596,6 +600,7 @@
             "timestamp": 0,
             "previous": null,
             "repository": null,
+            "submodule_commits": {},
             "github": {
                 "contributors": []
             },
@@ -610,6 +615,7 @@
             }
         },
         "repository": "/home/johndoe/repo/",
+        "submodule_commits": {},
         "github": {
             "contributors": []
         },

.github/fixtures/test-submodules-include-path/cliff.toml

@@ -0,0 +1,52 @@
+# git-cliff ~ configuration file
+# https://git-cliff.org/docs/configuration
+
+[changelog]
+# A Tera template to be rendered as the changelog's header.
+# See https://keats.github.io/tera/docs/#introduction
+header = """
+# Changelog\n
+All notable changes to this project will be documented in this file.\n
+"""
+# A Tera template to be rendered for each release in the changelog.
+# See https://keats.github.io/tera/docs/#introduction
+body = """
+{% if version %}\
+    ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
+{% else %}\
+    ## [unreleased]
+{% endif %}\
+{% for group, commits in commits | group_by(attribute="group") %}
+    ### {{ group | upper_first }}
+    {% for commit in commits %}
+        - {{ commit.message | upper_first }}\
+    {% endfor %}
+{% endfor %}\
+{% for submodule_path, commits in submodule_commits %}
+    ### {{ submodule_path | upper_first }}
+    {% for group, commits in commits | group_by(attribute="group") %}
+        #### {{ group | upper_first }}
+        {% for commit in commits %}
+            - {{ commit.message | upper_first }}\
+        {% endfor %}
+    {% endfor %}
+{% endfor %}\n
+"""
+# A Tera template to be rendered as the changelog's footer.
+# See https://keats.github.io/tera/docs/#introduction
+footer = """
+<!-- generated by git-cliff -->
+"""
+# Remove leading and trailing whitespaces from the changelog's body.
+trim = true
+
+[git]
+# An array of regex based parsers for extracting data from the commit message.
+# Assigns commits to groups.
+# Optionally sets the commit's `scope` and can decide to exclude commits from further processing.
+commit_parsers = [
+    { message = "^feat", group = "Features", default_scope = "app" },
+    { message = "^fix", group = "Bug Fixes", scope = "cli" },
+    { message = "^ci", group = "Continuous Integration" },
+]
+recurse_submodules = true

.github/fixtures/test-submodules-include-path/commit.sh

@@ -0,0 +1,42 @@
+#!/usr/bin/env bash
+set -e
+
+current_dir="$(pwd)"
+submodule_one_dir="$(mktemp -d)"
+submodule_two_dir="$(mktemp -d)"
+
+cd $submodule_one_dir && git init >&2
+GIT_COMMITTER_DATE="2022-04-05 01:00:8" git commit --allow-empty -m "feat: submodule_one initial commit"
+
+cd $submodule_two_dir && git init >&2
+GIT_COMMITTER_DATE="2022-04-05 01:00:12" git commit --allow-empty -m "feat: submodule_two feature B"
+
+cd $current_dir
+GIT_COMMITTER_DATE="2022-04-06 01:25:08" git commit --allow-empty -m "Initial commit"
+
+git -c protocol.file.allow=always submodule add $submodule_one_dir submodule_one
+GIT_COMMITTER_DATE="2022-04-06 01:25:09" git commit -a -m "feat: add submodule_one"
+
+cd submodule_one
+GIT_COMMITTER_DATE="2022-04-05 01:00:10" git commit --allow-empty -m "feat: submodule_one feature A"
+GIT_COMMITTER_DATE="2022-04-05 01:00:11" git commit --allow-empty -m "fix: submodule_one fix A"
+cd ..
+
+GIT_COMMITTER_DATE="2022-04-06 01:25:10" git commit -a -m "feat: submodule_one update 1"
+git tag v0.1.0
+
+git -c protocol.file.allow=always submodule add $submodule_two_dir submodule_two
+GIT_COMMITTER_DATE="2022-04-06 01:25:11" git commit -a -m "feat: submodule_two with initial commits"
+
+cd submodule_two
+GIT_COMMITTER_DATE="2022-04-05 01:00:13" git commit --allow-empty -m "fix: submodule_two fix B"
+cd ..
+
+GIT_COMMITTER_DATE="2022-04-06 01:25:12" git commit -a -m "feat: submodule_two update 1"
+git tag v0.2.0
+
+cd submodule_two
+GIT_COMMITTER_DATE="2022-04-05 01:00:14" git commit --allow-empty -m "fix: submodule_two fix C"
+cd ..
+
+GIT_COMMITTER_DATE="2022-04-06 01:25:13" git commit -a -m "feat: submodule_two update 2"

.github/fixtures/test-submodules-include-path/expected.md

@@ -0,0 +1,48 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [unreleased]
+
+### Features
+
+- Submodule_two update 2
+
+### Submodule_two
+
+#### Bug Fixes
+
+- Submodule_two fix C
+
+
+## [0.2.0] - 2022-04-06
+
+### Features
+
+- Submodule_two with initial commits
+- Submodule_two update 1
+
+### Submodule_one
+
+#### Bug Fixes
+
+- Submodule_one fix A
+
+#### Features
+
+- Submodule_one feature A
+- Submodule_one initial commit
+
+
+### Submodule_two
+
+#### Bug Fixes
+
+- Submodule_two fix B
+
+#### Features
+
+- Submodule_two feature B
+
+
+<!-- generated by git-cliff -->

.github/fixtures/test-submodules/cliff.toml

@@ -0,0 +1,52 @@
+# git-cliff ~ configuration file
+# https://git-cliff.org/docs/configuration
+
+[changelog]
+# A Tera template to be rendered as the changelog's header.
+# See https://keats.github.io/tera/docs/#introduction
+header = """
+# Changelog\n
+All notable changes to this project will be documented in this file.\n
+"""
+# A Tera template to be rendered for each release in the changelog.
+# See https://keats.github.io/tera/docs/#introduction
+body = """
+{% if version %}\
+    ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
+{% else %}\
+    ## [unreleased]
+{% endif %}\
+{% for group, commits in commits | group_by(attribute="group") %}
+    ### {{ group | upper_first }}
+    {% for commit in commits %}
+        - {{ commit.message | upper_first }}\
+    {% endfor %}
+{% endfor %}\
+{% for submodule_path, commits in submodule_commits %}
+    ### {{ submodule_path | upper_first }}
+    {% for group, commits in commits | group_by(attribute="group") %}
+        #### {{ group | upper_first }}
+        {% for commit in commits %}
+            - {{ commit.message | upper_first }}\
+        {% endfor %}
+    {% endfor %}
+{% endfor %}\n
+"""
+# A Tera template to be rendered as the changelog's footer.
+# See https://keats.github.io/tera/docs/#introduction
+footer = """
+<!-- generated by git-cliff -->
+"""
+# Remove leading and trailing whitespaces from the changelog's body.
+trim = true
+
+[git]
+# An array of regex based parsers for extracting data from the commit message.
+# Assigns commits to groups.
+# Optionally sets the commit's `scope` and can decide to exclude commits from further processing.
+commit_parsers = [
+    { message = "^feat", group = "Features", default_scope = "app" },
+    { message = "^fix", group = "Bug Fixes", scope = "cli" },
+    { message = "^ci", group = "Continuous Integration" },
+]
+recurse_submodules = true

.github/fixtures/test-submodules/commit.sh

@@ -0,0 +1,42 @@
+#!/usr/bin/env bash
+set -e
+
+current_dir="$(pwd)"
+submodule_one_dir="$(mktemp -d)"
+submodule_two_dir="$(mktemp -d)"
+
+cd $submodule_one_dir && git init >&2
+GIT_COMMITTER_DATE="2022-04-05 01:00:8" git commit --allow-empty -m "feat: submodule_one initial commit"
+
+cd $submodule_two_dir && git init >&2
+GIT_COMMITTER_DATE="2022-04-05 01:00:12" git commit --allow-empty -m "feat: submodule_two feature B"
+
+cd $current_dir
+GIT_COMMITTER_DATE="2022-04-06 01:25:08" git commit --allow-empty -m "Initial commit"
+
+git -c protocol.file.allow=always submodule add $submodule_one_dir submodule_one
+GIT_COMMITTER_DATE="2022-04-06 01:25:09" git commit -a -m "feat: add submodule_one"
+
+cd submodule_one
+GIT_COMMITTER_DATE="2022-04-05 01:00:10" git commit --allow-empty -m "feat: submodule_one feature A"
+GIT_COMMITTER_DATE="2022-04-05 01:00:11" git commit --allow-empty -m "fix: submodule_one fix A"
+cd ..
+
+GIT_COMMITTER_DATE="2022-04-06 01:25:10" git commit -a -m "feat: submodule_one update 1"
+git tag v0.1.0
+
+git -c protocol.file.allow=always submodule add $submodule_two_dir submodule_two
+GIT_COMMITTER_DATE="2022-04-06 01:25:11" git commit -a -m "feat: submodule_two with initial commits"
+
+cd submodule_two
+GIT_COMMITTER_DATE="2022-04-05 01:00:13" git commit --allow-empty -m "fix: submodule_two fix B"
+cd ..
+
+GIT_COMMITTER_DATE="2022-04-06 01:25:12" git commit -a -m "feat: submodule_two update 1"
+git tag v0.2.0
+
+cd submodule_two
+GIT_COMMITTER_DATE="2022-04-05 01:00:14" git commit --allow-empty -m "fix: submodule_two fix C"
+cd ..
+
+GIT_COMMITTER_DATE="2022-04-06 01:25:13" git commit -a -m "feat: submodule_two update 2"

.github/fixtures/test-submodules/expected.md

@@ -0,0 +1,55 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [unreleased]
+
+### Features
+
+- Submodule_two update 2
+
+### Submodule_two
+
+#### Bug Fixes
+
+- Submodule_two fix C
+
+
+## [0.2.0] - 2022-04-06
+
+### Features
+
+- Submodule_two with initial commits
+- Submodule_two update 1
+
+### Submodule_two
+
+#### Bug Fixes
+
+- Submodule_two fix B
+
+#### Features
+
+- Submodule_two feature B
+
+
+## [0.1.0] - 2022-04-06
+
+### Features
+
+- Add submodule_one
+- Submodule_one update 1
+
+### Submodule_one
+
+#### Bug Fixes
+
+- Submodule_one fix A
+
+#### Features
+
+- Submodule_one feature A
+- Submodule_one initial commit
+
+
+<!-- generated by git-cliff -->

.github/workflows/test-fixtures.yml

@@ -108,6 +108,9 @@ jobs:
             command: v2.6.1..v2.7.0 --include-path .github/fixtures/
           - fixtures-name: test-require-conventional-negative
           - fixtures-name: test-require-conventional-skipped
+          - fixtures-name: test-submodules
+          - fixtures-name: test-submodules-include-path
+            command: --include-path submodule_two
           - fixtures-name: test-remote-config
             command: --config-url "https://github.com/orhun/git-cliff/blob/main/.github/fixtures/new-fixture-template/cliff.toml?raw=true"