fix wrong typo in jenkinsfile

Jenkinsfile

@@ -184,16 +184,14 @@ pipeline {
 				
 				sh(". ~/BUILD_ENV/bin/activate && pip install --upgrade setuptools build pip copier jinja2-slug toml")
 				
-                sh(". ~/TOOLS_ENV/bin/activate && pip install simple_rest_client requests twine")
+                sh(". ~/TOOLS_ENV/bin/activate && pip install simple_rest_client requests twine packaging")
                 
                 script {
                     if(_PROJECT_NAME!="pygitversionhelper") {
                         sh(". ~/TOOLS_ENV/bin/activate && pip install pygitversionhelper")
                     }
-                    else
-                    {   
-                        //TODO: need to install pygitversionhelper deps from a better way...
-                        sh(". ~/TOOLS_ENV/bin/activate && pip install packaging")
+                    if(_PROJECT_NAME!="pychangelogfactory") {
+                        sh(". ~/TOOLS_ENV/bin/activate && pip install pychangelogfactory")
                     }
                 }
                 sh("git config --global user.email $_MaintainerEmail")
@@ -574,6 +572,11 @@ pipeline {
                                         |from simple_rest_client.resource import Resource
                                         |
                                         |try:
+                                        |    from pychangelogfactory import ChangelogFactory
+                                        |except ImportError:
+                                        |    from src.pychangelogfactory import ChangelogFactory
+                                        |
+                                        |try:
                                         |    from pygitversionhelper import gitversionhelper
                                         |except ImportError:
                                         |    from src.pygitversionhelper import gitversionhelper
@@ -619,6 +622,12 @@ pipeline {
 										|ReleaseContent  = "${_ReleaseContent_Title}" + "\\n" \\
 										|                + "\\n" \\
                                         |                + "Reference documentation: [mkdocs page](https://chacha.ddns.net/mkdocs-web/${_PROJECT_USER_NAME}/${PY_PROJECT_NAME}/${_GIT_BRANCH}/${PY_PROJECT_VERSION_STRIPPED}/) "
+										|
+										|LastTag=gitversionhelper.tag.getLastTag(same_branch=True)
+										|CommitHistory=gitversionhelper.commit.getMessagesSinceTag(LastTag, merged_output=True, ignore_merged=True)
+										|Changelog = ChangelogFactory(CommitHistory).RenderFullChangelog()
+										|
+										|ReleaseContent = ReleaseContent + "\\n"+ "\\n"+ "#Changelog\\n" + Changelog
 										|
 										|data={
 										|    "body":				ReleaseContent,

helpers/complexity_check.py

@@ -19,7 +19,6 @@ from radon.cli import Config
 from radon.cli.harvest import CCHarvester, HCHarvester, MIHarvester
 
 from .helper_base import helper_withresults_base
-from pprint import pprint
 
 
 class complexity_check(helper_withresults_base):

mkdocs.yml

@@ -1,11 +1,11 @@
 docs_dir: docs
 site_name: pygitversionhelper
-site_url: 'https://chacha.ddns.net/mkdocs-web/chacha/pygitversionhelper/latest/'
-site_description: 'A simple simple git version helper in python.'
+site_url: https://chacha.ddns.net/mkdocs-web/chacha/pygitversionhelper/latest/
+site_description: A simple simple git version helper in python.
 site_author: prune
-repo_url: 'https://chacha.ddns.net/gitea/chacha/pygitversionhelper'
+repo_url: https://chacha.ddns.net/gitea/chacha/pygitversionhelper
 use_directory_urls: false
-copyright: 'CC BY-NC-SA 4.0'
+copyright: CC BY-NC-SA 4.0
 theme:
   name: material
   features:
@@ -57,6 +57,13 @@ plugins:
           show_root_full_path: false
           merge_init_into_class: true
           separate_signature: true
+- with-pdf:
+    cover_subtitle: User Manual
+    cover_logo: C:\Users\chacha\git\pygitversionhelper\docs-static\Library.jpg
+    verbose: false
+    exclude_pages:
+    - LICENSE
+    output_path: C:\Users\chacha\git\pygitversionhelper\helpers-results\doc_gen\site\pdf\manual.pdf
 markdown_extensions:
 - def_list
 - tables

src/pygitversionhelper/gitversionhelper.py

@@ -57,6 +57,7 @@ if TYPE_CHECKING:
             "merged_output": Optional[bool],
             "ignore_unknown_tags": Optional[bool],
             "output_format": Optional[str],
+            "ignore_merged": Optional[bool],
         },
         total=False,
     )
@@ -157,16 +158,29 @@ class gitversionhelper:  # pylint: disable=too-few-public-methods
             Keyword Arguments:
                 kwargs/merged_output (bool): Output one single merged string
                 kwargs/same_branch (bool): Force searching only in the same branch
+                kwargs/ignore_merged (bool): ignore merged commits
             Returns:
                 the commit message
             """
             current_commit_id = cls.getLast(**kwargs)
+            print(f"current_commit_id = {current_commit_id}")
             tag_commit_id = cls.getFromTag(tag)
+            print(f"tag_commit_id = {tag_commit_id}")
 
+            str_cmd: str
             if ("same_branch" in kwargs) and (kwargs["same_branch"] is True):
-                commits = _exec(f"git rev-list --first-parent --ancestry-path {tag_commit_id}..{current_commit_id}")
+                str_cmd = f"git rev-list --first-parent {tag_commit_id}..{current_commit_id}"  # ok
             else:
-                commits = _exec(f"git rev-list --ancestry-path {tag_commit_id}..{current_commit_id}")
+                str_cmd = f"git rev-list {tag_commit_id}..{current_commit_id}"  # ok
+
+            if ("ignore_merged" in kwargs) and (kwargs["ignore_merged"] is True):
+                str_cmd = str_cmd + " --no-merges"  # ok
+
+            try:
+                commits = _exec(str_cmd)
+            except gitversionhelper.unknownGITFatalError as _e:
+                raise cls.commitNotFound("no commit found in commit history") from _e
+
             result = []
             for commit in commits:
                 result.append(cls.getMessage(commit))
@@ -185,7 +199,7 @@ class gitversionhelper:  # pylint: disable=too-few-public-methods
             """
             try:
                 res = _exec(
-                    f'git log -z --pretty="tformat:%B%-C()" -n 1 {commit_hash}',
+                    f'git log -z --pretty="tformat:%B%-C()" -n 1 {commit_hash}',  # ok
                     None,
                     True,
                 )
@@ -204,9 +218,10 @@ class gitversionhelper:  # pylint: disable=too-few-public-methods
                 the commit Id
             """
             try:
-                res = _exec(f"git rev-list -n 1 {tag}")
+                res = _exec(f"git rev-list -n 1 {tag}")  # ok
             except gitversionhelper.unknownGITFatalError as _e:
                 raise cls.commitNotFound("no commit found in commit history") from _e
+
             if len(res) == 0:
                 raise cls.commitNotFound("no commit found in commit history")
             return res[0]
@@ -216,16 +231,23 @@ class gitversionhelper:  # pylint: disable=too-few-public-methods
             """retrieve last commit from repository
             Keyword Arguments:
                 kwargs/same_branch (bool): force searching only in the same branch
+                kwargs/ignore_merged (bool): ignore merged commits
             Returns:
                 the commit Id
             """
+            str_cmd: str
             if ("same_branch" in kwargs) and (kwargs["same_branch"] is True):
-                try:
-                    res = _exec("git rev-parse HEAD")
-                except gitversionhelper.unknownGITFatalError as _e:
-                    raise cls.commitNotFound("no commit found in commit history") from _e
+                str_cmd = "git rev-list --max-count=1 --date-order HEAD --first-parent"  # ok
             else:
-                res = _exec('git for-each-ref --sort=-committerdate refs/heads/ --count 1 --format="%(objectname)"')
+                str_cmd = "git log --format=%H --all -n1"  # ok
+
+            if ("ignore_merged" in kwargs) and (kwargs["ignore_merged"] is True):
+                str_cmd = str_cmd + " --no-merges"  # ok
+
+            try:
+                res = _exec(str_cmd)
+            except gitversionhelper.unknownGITFatalError as _e:
+                raise cls.commitNotFound("no commit found in commit history") from _e
 
             if len(res) == 0:
                 raise cls.commitNotFound("no commit found in commit history")

test/test_gitversionhelper.py

@@ -1009,6 +1009,16 @@ class Test_gitversionhelper(unittest.TestCase):
         self.assertEqual(_v.minor, 3)
         self.assertEqual(_v.patch, 0)
 
+        with open("demofile.txt", "w+t") as tmpFile:
+            tmpFile.write("testvalue4")
+        os.system("git add .")
+        os.system('git commit -m  "4th commit"')
+
+        with open("demofile.txt", "w+t") as tmpFile:
+            tmpFile.write("testvalue5")
+        os.system("git add .")
+        os.system('git commit -m  "5th commit"')
+
         os.system("git switch master")
 
         _v = pygitversionhelper.gitversionhelper.version.getLastVersion(version_std="PEP440")
@@ -1404,6 +1414,17 @@ class Test_gitversionhelper(unittest.TestCase):
         cmd = "git commit -m".split()
         cmd.append(commit_message5)
         subprocess.run(cmd, text=True, check=True)
+        os.system(f"git tag 0.1.1.post4")
+
+        commit_message6 = "6.1 update this" + os.linesep + "6.1 fix that" + os.linesep + "6.1 test"
+        commit_message6 = commit_message6.replace("\r\n", "\n").replace("\n", "\r\n")
+        with open("demofile.txt", "w+t") as tmpFile:
+            tmpFile.write("testvalue6")
+        os.system("git add .")
+
+        cmd = "git commit -m".split()
+        cmd.append(commit_message6)
+        subprocess.run(cmd, text=True, check=True)
 
         cmd = "git switch master".split()
         subprocess.run(cmd, text=True, check=True)
@@ -1412,7 +1433,42 @@ class Test_gitversionhelper(unittest.TestCase):
         self.assertEqual(os.linesep.join([commit_message4, commit_message3, commit_message2]), res)
 
         res = pygitversionhelper.gitversionhelper.commit.getMessagesSinceTag("0.1.1", merged_output=True)
-        self.assertEqual(os.linesep.join([commit_message5, commit_message4, commit_message3, commit_message2]), res)
+        self.assertEqual(os.linesep.join([commit_message6, commit_message5, commit_message4, commit_message3, commit_message2]), res)
+
+        time.sleep(1)
+
+        merge_message = "automerge"
+        cmd = "git merge --no-ff dev -m".split()
+        cmd.append(merge_message)
+        subprocess.run(cmd, text=True, check=True)
+
+        res = pygitversionhelper.gitversionhelper.commit.getMessagesSinceTag("0.1.1", merged_output=True, same_branch=True)
+        self.assertEqual(os.linesep.join([merge_message, commit_message4, commit_message3, commit_message2]), res)
+
+        res = pygitversionhelper.gitversionhelper.commit.getMessagesSinceTag("0.1.1", merged_output=True)
+        self.assertEqual(
+            set(
+                merge_message.splitlines()
+                + commit_message6.splitlines()
+                + commit_message5.splitlines()
+                + commit_message4.splitlines()
+                + commit_message3.splitlines()
+                + commit_message2.splitlines()
+            ),
+            set(res.splitlines()),
+        )
+
+        res = pygitversionhelper.gitversionhelper.commit.getMessagesSinceTag("0.1.1", merged_output=True, ignore_merged=True)
+        self.assertEqual(
+            set(
+                commit_message6.splitlines()
+                + commit_message5.splitlines()
+                + commit_message4.splitlines()
+                + commit_message3.splitlines()
+                + commit_message2.splitlines()
+            ),
+            set(res.splitlines()),
+        )
 
     def tearDown(self):
         os.chdir("/")