feat!: adding Git parser mode

Author: DeveloperC286

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "conventional_commits_next_version"
-version = "5.0.0"
+version = "6.0.0"
 description = "A tooling and language agnostic utility to calculate the next semantic version based on the Conventional Commits since the prior version. Supports monorepos."
 authors = ["C <[email protected]>"]
 edition = "2021"
@@ -25,4 +25,4 @@ git2 = { version = "0.13.25", default-features = false, features=[] }
 # For Semantic Versioning parsing.
 semver = "1.0.5"
 
-conventional_commits_next_version_lib = "0.2.0"
+conventional_commits_next_version_lib = "0.3.0"

conventional_commits_next_version/Cargo.toml

@@ -129,9 +129,10 @@ Additional command line flags can be passed to alter what and how the next Seman
 
 | Flag                      | |
 |---------------------------|-|
+| --monorepo | The the next semantic version is calculated only from commits altering files which match any of these provided regexes, enabling usage within monorepos. |
+| --git-history-mode | The mode to use when transversing the Git commit history of the Git commit range, to collect the Git commit messages to use in calculating the next semantic version. |
 | --calculation-mode | The mode of calculation to use on the range of Commits to calculate the next semantic version. |
 | --current-version | This Semantic Versioning is asserted to be equal or larger than the calculated Semantic Versioning. The calculated Semantic Versioning is not printed to standard out. If the assertion is not met then it exits with a non zero exit code. |
-| --monorepo | The the next semantic version is calculated only from commits altering files which match any of these provided regexes, enabling usage within monorepos. |
 
 
 ### Usage - Git Environment Variables

conventional_commits_next_version/README.md

@@ -17,5 +17,4 @@ Feature: The increments are applied consecutively to calculate the next Semantic
       | https://github.com/yargs/yargs.git      | b9409da199ebca515a848489c206b807fab2e65d | 6e4bc2aa0a6c5560928296f18e008a15b2aaf335 | 1.1.3        | 2.0.0            |
       | https://github.com/yargs/yargs.git      | 0aaa68bf36d35c697426de4dfe2e4e12128c2dc0 | 927810c7615912fb77a160273b2d6a946e9737b8 | 9.4.0        | 10.0.0           |
       | https://github.com/yargs/yargs.git      | 6014e39bca3a1e8445aa0fb2a435f6181e344c45 | 705384762919641fe9d4c0967452a292f5f52c6d | 1.2.0        | 1.4.0            |
-      | https://github.com/dcyou/resume.git     | 9015044aba82dbe8aa0119bffd7ea73cad171dd0 | fe14480df04f76e6434d45c762ab087df41b8473 | 1.2.2        | 1.3.30           |
       | https://gitlab.com/dmfay/massive-js.git | 482c364acf5505b81c55245fac0472890d351662 | 3f20134864b19b11541287af440540c7ad0ed986 | 7.2.0        | 7.5.3            |

conventional_commits_next_version/end-to-end-tests/features/consecutive-semantic-versioning.feature

@@ -37,7 +37,6 @@ Feature: A shortened Git commit hash can be provided as an argument to indicate
       | repository                              | checkout_commit                          | from_commit_hash                         | from_version | expected_version | shortened_from_commit_hash |
       | https://github.com/yargs/yargs.git      | 089417550ef5a5b8ce3578dd2a989191300b64cd | 262e796329f4a09083ca07e49f926ae43ac850e9 | 0.2.1        | 0.2.2            | 262e796                    |
       | https://github.com/yargs/yargs.git      | 6014e39bca3a1e8445aa0fb2a435f6181e344c45 | 705384762919641fe9d4c0967452a292f5f52c6d | 1.2.0        | 1.4.0            | 7053847                    |
-      | https://github.com/dcyou/resume.git     | 9015044aba82dbe8aa0119bffd7ea73cad171dd0 | fe14480df04f76e6434d45c762ab087df41b8473 | 1.2.2        | 1.3.30           | fe14480                    |
       | https://gitlab.com/dmfay/massive-js.git | 482c364acf5505b81c55245fac0472890d351662 | 3f20134864b19b11541287af440540c7ad0ed986 | 7.2.0        | 7.5.3            | 3f20134                    |
 
 
@@ -51,7 +50,6 @@ Feature: A shortened Git commit hash can be provided as an argument to indicate
     Examples:
       | repository                              | checkout_commit                          | from_shortened_commit_hash | from_version |
       | https://github.com/yargs/yargs.git      | 089417550ef5a5b8ce3578dd2a989191300b64cd | 272a194                    | 0.2.1        |
-      | https://github.com/dcyou/resume.git     | 9015044aba82dbe8aa0119bffd7ea73cad171dd0 | fd13487                    | 1.2.2        |
       | https://gitlab.com/dmfay/massive-js.git | 482c364acf5505b81c55245fac0472890d351662 | 3f235ee                    | 7.2.0        |
 
 

conventional_commits_next_version/end-to-end-tests/features/from-shortened-commit-hash.feature

@@ -0,0 +1,14 @@
+Feature: All the parents of merge commit's are parsed for their Git commit messages.
+
+
+  Scenario Outline:
+    Given the repository "<repository>" is cloned and checked out at the commit "<checkout_commit>".
+    When the argument --from-version is provided as "<from_version>".
+    And the argument --from-commit-hash is provided as "<from_commit_hash>".
+    And the argument --git-history-mode is provided as "AllParents".
+    Then the returned version should be "<expected_version>".
+
+
+    Examples:
+      | repository                          | checkout_commit                          | from_commit_hash                         | from_version | expected_version |
+      | https://github.com/dcyou/resume.git | 9015044aba82dbe8aa0119bffd7ea73cad171dd0 | fe14480df04f76e6434d45c762ab087df41b8473 | 1.2.2        | 1.3.30           |

conventional_commits_next_version/end-to-end-tests/features/git-history-all-parents-mode.feature

@@ -0,0 +1,13 @@
+Feature: Only the first parent of merge commit's are parsed for their Git commit messages.
+
+
+  Scenario Outline:
+    Given the repository "<repository>" is cloned and checked out at the commit "<checkout_commit>".
+    When the argument --from-version is provided as "<from_version>".
+    And the argument --from-commit-hash is provided as "<from_commit_hash>".
+    Then the returned version should be "<expected_version>".
+
+
+    Examples:
+      | repository                          | checkout_commit                          | from_commit_hash                         | from_version | expected_version |
+      | https://github.com/dcyou/resume.git | 9015044aba82dbe8aa0119bffd7ea73cad171dd0 | fe14480df04f76e6434d45c762ab087df41b8473 | 1.2.2        | 1.3.1            |

conventional_commits_next_version/end-to-end-tests/features/git-history-first-parent-mode.feature

@@ -101,10 +101,10 @@ def then_ambiguous_shortened_commit_hash_error(context, shortened_commit_hash):
 def then_missing_from_argument_error(context):
     # Given
     missing_from_argument_error = "error: The following required arguments were not provided:\n" + \
-                                  "    <--from-stdin|--from-commit-hash <from-commit-hash>|--from-reference <from-reference>>\n" + \
+                                  "    <--from-stdin|--from-reference <from-reference>|--from-commit-hash <from-commit-hash>>\n" + \
                                   "\n" + \
                                   "USAGE:\n" + \
-                                  "    conventional_commits_next_version --calculation-mode <calculation-mode> --from-version <from-version> <--from-stdin|--from-commit-hash <from-commit-hash>|--from-reference <from-reference>>\n" + \
+                                  "    conventional_commits_next_version --calculation-mode <calculation-mode> --from-version <from-version> --git-history-mode <git-history-mode> <--from-stdin|--from-reference <from-reference>|--from-commit-hash <from-commit-hash>>\n" + \
                                   "\n" + \
                                   "For more information try --help\n"
 
@@ -120,7 +120,7 @@ def then_conflicting_from_arguments_error(context):
     # Given
     conflicting_arguments_end = "\n" + \
         "USAGE:\n" + \
-        "    conventional_commits_next_version --calculation-mode <calculation-mode> --from-version <from-version> <--from-stdin|--from-commit-hash <from-commit-hash>|--from-reference <from-reference>>\n" + \
+        "    conventional_commits_next_version --calculation-mode <calculation-mode> --from-version <from-version> --git-history-mode <git-history-mode> <--from-stdin|--from-reference <from-reference>|--from-commit-hash <from-commit-hash>>\n" + \
         "\n" + \
         "For more information try --help\n"
 

conventional_commits_next_version/end-to-end-tests/features/steps/then.py

@@ -9,11 +9,26 @@ def set_from_stdin(context, standard_input):
     context.arguments += " --from-stdin "
 
 
+@when('the argument --from-reference is provided as "{from_reference}".')
+def set_from_reference(context, from_reference):
+    context.arguments += " --from-reference " + from_reference + " "
+
+
 @when('the argument --from-commit-hash is provided as "{from_commit_hash}".')
 def set_from_commit_hash(context, from_commit_hash):
     context.arguments += " --from-commit-hash " + from_commit_hash + " "
 
 
+@when('the argument --monorepo is provided as "{monorepo}".')
+def set_monorepo(context, monorepo):
+    context.arguments += " --monorepo " + monorepo + " "
+
+
+@when('the argument --git-history-mode is provided as "AllParents".')
+def set_batch_commits_flag(context):
+    context.arguments += " --git-history-mode \"AllParents\" "
+
+
 @when('the argument --from-version is provided as "{from_version}".')
 def set_from_version(context, from_version):
     context.arguments += " --from-version " + from_version + " "
@@ -24,16 +39,6 @@ def set_batch_commits_flag(context):
     context.arguments += " --calculation-mode \"Batch\" "
 
 
-@when('the argument --monorepo is provided as "{monorepo}".')
-def set_monorepo(context, monorepo):
-    context.arguments += " --monorepo " + monorepo + " "
-
-
 @when('the argument --current-version is provided as "{current_version}".')
 def set_current_version(context, current_version):
     context.arguments += " --current-version " + current_version + " "
-
-
-@when('the argument --from-reference is provided as "{from_reference}".')
-def set_from_reference(context, from_reference):
-    context.arguments += " --from-reference " + from_reference + " "

conventional_commits_next_version/end-to-end-tests/features/steps/when.py

@@ -15,6 +15,13 @@ pub(crate) struct Arguments {
     )]
     pub(crate) from_stdin: bool,
 
+    #[structopt(
+        long,
+        group = "from",
+        help = "The Git reference from where to start taking the range of commits from till HEAD. The range is inclusive of HEAD and exclusive of the provided reference."
+    )]
+    pub(crate) from_reference: Option<String>,
+
     #[structopt(
         long,
         group = "from",
@@ -24,10 +31,16 @@ pub(crate) struct Arguments {
 
     #[structopt(
         long,
-        group = "from",
-        help = "The Git reference from where to start taking the range of commits from till HEAD. The range is inclusive of HEAD and exclusive of the provided reference."
+        help = "The the next semantic version is calculated only from commits altering files which match any of these provided regexes, enabling usage within monorepos."
     )]
-    pub(crate) from_reference: Option<String>,
+    pub(crate) monorepo: Vec<String>,
+
+    #[structopt(
+        long,
+        default_value = "FirstParent",
+        help = "The mode to use when transversing the Git commit history of the Git commit range, to collect the Git commit messages to use in calculating the next semantic version."
+    )]
+    pub(crate) git_history_mode: conventional_commits_next_version_lib::GitHistoryMode,
 
     #[structopt(
         long,
@@ -49,12 +62,6 @@ pub(crate) struct Arguments {
         help = "This Semantic Versioning is asserted to be equal or larger than the calculated Semantic Versioning. The calculated Semantic Versioning is not printed to standard out. If the assertion is not met then it exits with a non zero exit code."
     )]
     pub(crate) current_version: Option<Version>,
-
-    #[structopt(
-        long,
-        help = "The the next semantic version is calculated only from commits altering files which match any of these provided regexes, enabling usage within monorepos."
-    )]
-    pub(crate) monorepo: Vec<String>,
 }
 
 fn parse_version(src: &str) -> Result<Version, Error> {