Changed and standardized to term 'summary'

Author: coordt

.changelog-config.yaml

@@ -9,7 +9,7 @@ starting_tag_pipeline:
     pattern: (?im)^## (?P<rev>\d+\.\d+(?:\.\d+)?)\s+\(\d+-\d{2}-\d{2}\)$
     named_subgroup: rev
 unreleased_label: Unreleased
-subject_pipeline:
+summary_pipeline:
 - action: strip_spaces
 - action: Strip
   comment: Get rid of any periods so we don't get double periods

generate_changelog/configuration.py

@@ -70,7 +70,7 @@
     },
 ]
 
-DEFAULT_SUBJECT_PIPELINE = [
+DEFAULT_SUMMARY_PIPELINE = [
     {"action": "strip_spaces"},
     {
         "action": "Strip",
@@ -117,8 +117,8 @@ class Configuration:
     unreleased_label: str = "Unreleased"
     """Used as the section title of the changes since the last valid tag."""
 
-    subject_pipeline: list = field(default_factory=list)
-    """Process the commit's subject for use in the changelog."""
+    summary_pipeline: list = field(default_factory=list)
+    """Process the commit's first line for use in the changelog."""
 
     body_pipeline: list = field(default_factory=list)
     """Process the commit's body for use in the changelog."""
@@ -186,7 +186,7 @@ def get_default_config() -> Configuration:
         ignore_patterns=DEFAULT_IGNORE_PATTERNS,
         section_patterns=DEFAULT_SECTION_PATTERNS,
         body_pipeline=DEFAULT_BODY_PIPELINE,
-        subject_pipeline=DEFAULT_SUBJECT_PIPELINE,
+        summary_pipeline=DEFAULT_SUMMARY_PIPELINE,
         starting_tag_pipeline=DEFAULT_STARTING_TAG_PIPELINE,
         output_pipeline=DEFAULT_OUTPUT_PIPELINE,
         valid_author_tokens=DEFAULT_VALID_AUTHOR_TOKENS,

generate_changelog/git_ops.py

@@ -1,13 +1,13 @@
 """git information access."""
 
-from typing import List, Optional
+from typing import List, Optional, Union
 
 import datetime
 import os
 import re
 from dataclasses import dataclass
 
-from git import Repo
+from git import Actor, Repo
 
 from generate_changelog.configuration import get_config
 
@@ -19,7 +19,7 @@
     "author_date_timestamp": "%at",
     "committer_name": "%cn",
     "committer_date_timestamp": "%ct",
-    "subject": "%s",
+    "summary": "%s",
     "body": "%b",
 }
 GIT_FULL_FORMAT_STRING = "%x00".join(GIT_FORMAT_KEYS.values()) + "%x1F"
@@ -31,7 +31,7 @@ class TagInfo:
 
     name: str
     commit: str
-    tagger: str
+    tagger: Union[str, Actor]
     tagged_datetime: datetime.datetime
 
     @property

generate_changelog/templates/commit.md.jinja

@@ -1,4 +1,4 @@
-- {{ commit.subject }}
+- {{ commit.summary }}
   {{ commit.body|indent(2, first=True) }}
   {% for key, val in commit.metadata["trailers"].items() %}
   {% if key not in VALID_AUTHOR_TOKENS %}

generate_changelog/templating.py

@@ -60,12 +60,12 @@ def get_context_from_tags(
                 continue
 
             commit_metadata_func = MetadataCollector()
-            subject_pipeline = pipeline_factory(
-                action_list=get_config().subject_pipeline,
+            summary_pipeline = pipeline_factory(
+                action_list=get_config().summary_pipeline,
                 commit_metadata_func=commit_metadata_func,
                 version_metadata_func=version_metadata_func,
             )
-            subject = subject_pipeline.run(commit.summary)
+            summary = summary_pipeline.run(commit.summary)
             body_pipeline = pipeline_factory(
                 action_list=get_config().body_pipeline,
                 commit_metadata_func=commit_metadata_func,
@@ -80,7 +80,7 @@ def get_context_from_tags(
                     sha=commit.hexsha,
                     commit_datetime=commit.committed_datetime,
                     committer=f"{commit.committer.name} <{commit.committer.email}>",
-                    subject=subject,
+                    summary=summary,
                     body=body,
                     metadata=commit_metadata_func.metadata.copy(),
                 )
@@ -128,9 +128,9 @@ def render(repository: Repo, config: Configuration, starting_tag: Optional[str]
         The full or partial changelog
     """
     version_context = get_context_from_tags(repository, config, starting_tag)
-    context = get_config().variables.copy()
+    context = config.variables.copy()
     context["versions"] = version_context
-    context["VALID_AUTHOR_TOKENS"] = get_config().valid_author_tokens
+    context["VALID_AUTHOR_TOKENS"] = config.valid_author_tokens
 
     if starting_tag:
         heading_str = default_env.get_template("heading.md.jinja").render()

test/test_log_linearity.py

@@ -82,12 +82,12 @@ def test_tags_on_multiple_branches(bare_git_repo, capsys):
     ver001 = context[4]
     assert len(unreleased.sections) == 0
     assert len(ver004.sections[0].commits) == 3
-    assert ver004.sections[0].commits[0].subject == "Commit 5 on master."
-    assert ver004.sections[0].commits[1].subject == "Commit 3 on develop."
-    assert ver004.sections[0].commits[2].subject == "Commit 2 on develop."
+    assert ver004.sections[0].commits[0].summary == "Commit 5 on master."
+    assert ver004.sections[0].commits[1].summary == "Commit 3 on develop."
+    assert ver004.sections[0].commits[2].summary == "Commit 2 on develop."
     assert len(ver003.sections[0].commits) == 1
-    assert ver003.sections[0].commits[0].subject == "Commit 4 on master."
+    assert ver003.sections[0].commits[0].summary == "Commit 4 on master."
     assert len(ver002.sections[0].commits) == 1
-    assert ver002.sections[0].commits[0].subject == "Commit 2 on develop."
+    assert ver002.sections[0].commits[0].summary == "Commit 2 on develop."
     assert len(ver001.sections[0].commits) == 1
-    assert ver001.sections[0].commits[0].subject == "Commit 1 on master."
+    assert ver001.sections[0].commits[0].summary == "Commit 1 on master."

test/test_templating.py

@@ -44,7 +44,7 @@ def test_commit_context():
         sha=commit.hexsha,
         commit_datetime=commit.committed_datetime,
         committer=f"{commit.committer.name} <{commit.committer.email}>",
-        subject=commit.summary,
+        summary=commit.summary,
         body="\n".join(commit.message.splitlines()[1:]),
     )
     assert commit.hexsha[:7] == context.short_sha
@@ -61,7 +61,7 @@ def test_commit_with_no_email():
         sha=commit.hexsha,
         commit_datetime=commit.committed_datetime,
         committer=f"{commit.committer.name} <{commit.committer.email}>",
-        subject=commit.summary,
+        summary=commit.summary,
         body="\n".join(commit.message.splitlines()[1:]),
         metadata={"trailers": {"co-authored-by": [name_only]}},
     )