python-semantic-release 9.2.2__py3-none-any.whl → 9.3.1__py3-none-any.whl

{python_semantic_release-9.2.2.dist-info → python_semantic_release-9.3.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-semantic-release
-Version: 9.2.2
+Version: 9.3.1
 Summary: Automatic Semantic Versioning for Python projects
 Author-email: Rolf Erik Lekang <me@rolflekang.com>
 License: MIT
@@ -35,7 +35,7 @@ Requires-Dist: shellingham >=1.5.0.post1
 Provides-Extra: dev
 Requires-Dist: pre-commit ; extra == 'dev'
 Requires-Dist: tox ; extra == 'dev'
-Requires-Dist: ruff ==0.3.2 ; extra == 'dev'
+Requires-Dist: ruff ==0.3.3 ; extra == 'dev'
 Provides-Extra: docs
 Requires-Dist: Sphinx <=6.0.0 ; extra == 'docs'
 Requires-Dist: sphinxcontrib-apidoc ==0.3.0 ; extra == 'docs'

{python_semantic_release-9.2.2.dist-info → python_semantic_release-9.3.1.dist-info}/RECORD

@@ -1,8 +1,8 @@
-semantic_release/__init__.py,sha256=UY60uqsKwT97THCS1FDDtGpgKytMBM6Hi3uMAfzJrLI,870
+semantic_release/__init__.py,sha256=FskRwovkP1zTcZTjLsLItxs24ykLO8-6VyZ_ffSU9EU,870
 semantic_release/__main__.py,sha256=vXOARLV7KHeVXgpOMU0Q-8wovpdsOrtTsycxulI5xIE,106
 semantic_release/const.py,sha256=Z1o2QNh60wSLeF-_1TemMBjU3ZXbV0XghnUFsbTVfOs,831
 semantic_release/enums.py,sha256=D5B_reQGGKQQT22HO5PUtvn2Bok3fkht6TfJtXkmAUg,1020
-semantic_release/errors.py,sha256=KKKCV45vvE9tla0sxYDGHkHWvqDn1gEfGIpzujcDbeI,809
+semantic_release/errors.py,sha256=8cNiMhgUTNZC0CecokLyl9YWxREHEh9otm1cRs9kkbU,1001
 semantic_release/helpers.py,sha256=d1jOX0SNyqPc_3wr14xR25FfpqhMd4Ev7MNBOWlScc0,5581
 semantic_release/changelog/__init__.py,sha256=Bg6Xe5Vt32rWoMscW-hd4sUwiZqzWmsg4CD1EhMesMY,262
 semantic_release/changelog/context.py,sha256=ItSz5Bon2mcJkLxyQZzBTukN0zEdcaVQ4iXvz3jGCLc,986
@@ -21,7 +21,7 @@ semantic_release/cli/commands/cli_context.py,sha256=fOLTUKb4UnZGQ6zVhftuvdfZ7fK7
 semantic_release/cli/commands/generate_config.py,sha256=2xZOu3NpyhBp0pWr7d8ugKl_kjqQgpSsSMHq5wHTfrE,1699
 semantic_release/cli/commands/main.py,sha256=LuL-O0LGonI5fQTZn0AUtYv2Ei_CYyNqYHMF_wN4InI,2900
 semantic_release/cli/commands/publish.py,sha256=_pz7rKx65tCH7J2uyWiBghQ61MmmIbxhF9bE4AkE0N8,1703
-semantic_release/cli/commands/version.py,sha256=1YfdvAkaammmgVRCFcGPujM2fNUvl5DN8xL3utGOzKE,22461
+semantic_release/cli/commands/version.py,sha256=jz3ao9AV0YeMAwZULSnnanl6OL-NWIc5rnr9E7BrZL0,22111
 semantic_release/commit_parser/__init__.py,sha256=cv5HFBdw7OJd4Laj4Ex8ZZ5Tml8GwXgQcXW6Pasr2Ao,615
 semantic_release/commit_parser/_base.py,sha256=aDS0dhFosT5i11tA5Ez8BTeikk6jwXjSEpJnJC5D2cs,2609
 semantic_release/commit_parser/angular.py,sha256=bS7Wrzpg_6zFil5Y4GIZkeGDPhvWQdTlFdWTtGVcpp0,4393
@@ -41,14 +41,14 @@ semantic_release/hvcs/gitlab.py,sha256=qSvNdQK40QM20-HDh3eIO6Rz8Lo3PEND_4kluugVx
 semantic_release/hvcs/token_auth.py,sha256=ZjT56-NIPB4OKIt1qwHCu1TavXnrWFIBl9ARlg56hgU,663
 semantic_release/hvcs/util.py,sha256=PNKXApgL2np9lpnKjAbo77toRgElLPXrbS1q7621waI,2886
 semantic_release/version/__init__.py,sha256=CLhtGQry9dLIij5XyRa9ZevxU_1p8tjMTSQ-K_GMpWM,270
-semantic_release/version/algorithm.py,sha256=K9WkPRur0x5baXsqEi8kvaDfxduG4WNUiALXZRXujJ4,16484
+semantic_release/version/algorithm.py,sha256=-9ulTy1z4u-jUvbc-FrvEdFL7Omc3O3HhaPohjiCmm0,16854
 semantic_release/version/declaration.py,sha256=f6Ld7hIhrqvDrRBapJHr-KDimuyo-4IG8009Zu9BIgU,7357
 semantic_release/version/translator.py,sha256=P1noIsVBn8u6zNOFjG0xKYOWapxqf_PHSMvMeLJ9kXg,3050
 semantic_release/version/version.py,sha256=6PCtSbLP88U1daoxnCwHc--YguZo4waGNLqJ5JfeczE,14175
-python_semantic_release-9.2.2.dist-info/AUTHORS.rst,sha256=XOReVvpymEFUPsS2QPH97jlfJBVrxwS2eu8-jVAe4gk,230
-python_semantic_release-9.2.2.dist-info/LICENSE,sha256=NE85nszX252sdQdu0xgS9qwfYES0k8qS6gW3uO4jRGE,1083
-python_semantic_release-9.2.2.dist-info/METADATA,sha256=b41gxhINO5-3krE8YC0-_sQSa8G4L5zFuOlMd9Rsd0A,5365
-python_semantic_release-9.2.2.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-python_semantic_release-9.2.2.dist-info/entry_points.txt,sha256=qojUBx_Ywf4u7KgP6NWlDaBDymZVUGQ7m5wF2duC2F0,95
-python_semantic_release-9.2.2.dist-info/top_level.txt,sha256=qYA24nyg3eP-ti5UW7Vuj2aXVmM0wqVHx4mREdRZNAA,17
-python_semantic_release-9.2.2.dist-info/RECORD,,
+python_semantic_release-9.3.1.dist-info/AUTHORS.rst,sha256=XOReVvpymEFUPsS2QPH97jlfJBVrxwS2eu8-jVAe4gk,230
+python_semantic_release-9.3.1.dist-info/LICENSE,sha256=NE85nszX252sdQdu0xgS9qwfYES0k8qS6gW3uO4jRGE,1083
+python_semantic_release-9.3.1.dist-info/METADATA,sha256=5qM5BEHU7GNT6jkoRTluZCmmrJUJDtrWOKHbbwJUmII,5365
+python_semantic_release-9.3.1.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+python_semantic_release-9.3.1.dist-info/entry_points.txt,sha256=qojUBx_Ywf4u7KgP6NWlDaBDymZVUGQ7m5wF2duC2F0,95
+python_semantic_release-9.3.1.dist-info/top_level.txt,sha256=qYA24nyg3eP-ti5UW7Vuj2aXVmM0wqVHx4mREdRZNAA,17
+python_semantic_release-9.3.1.dist-info/RECORD,,

semantic_release/__init__.py

@@ -24,7 +24,7 @@ from semantic_release.version import (
     tags_and_versions,
 )
 
-__version__ = "9.2.2"
+__version__ = "9.3.1"
 
 
 def setup_hook(argv: list[str]) -> None:

semantic_release/cli/commands/version.py

@@ -375,13 +375,71 @@ def version(  # noqa: C901
 
     rprint(f"[bold green]The next version is: [white]{new_version!s}[/white]! :rocket:")
 
+    rh = ReleaseHistory.from_git_history(
+        repo=repo,
+        translator=translator,
+        commit_parser=parser,
+        exclude_commit_patterns=changelog_excluded_commit_patterns,
+    )
+
+    commit_date = datetime.now()
+    try:
+        rh = rh.release(
+            new_version,
+            tagger=commit_author,
+            committer=commit_author,
+            tagged_date=commit_date,
+        )
+    except ValueError as ve:
+        ctx.fail(str(ve))
+
+    all_paths_to_add: list[str] = []
+
+    if update_changelog:
+        changelog_context = make_changelog_context(
+            hvcs_client=hvcs_client, release_history=rh
+        )
+        changelog_context.bind_to_environment(env)
+
+        if template_dir.is_dir():
+            if opts.noop:
+                noop_report(
+                    f"would have recursively rendered the template directory "
+                    f"{template_dir!r} relative to {repo.working_dir!r}. "
+                    "Paths which would be modified by this operation cannot be "
+                    "determined in no-op mode."
+                )
+            else:
+                all_paths_to_add.extend(
+                    recursive_render(
+                        template_dir, environment=env, _root_dir=repo.working_dir
+                    )
+                )
+
+        else:
+            log.info(
+                "Path %r not found, using default changelog template", template_dir
+            )
+            if opts.noop:
+                noop_report(
+                    "would have written your changelog to "
+                    + str(changelog_file.relative_to(repo.working_dir))
+                )
+            else:
+                changelog_text = render_default_changelog_file(env)
+                changelog_file.write_text(f"{changelog_text}\n", encoding="utf-8")
+
+            all_paths_to_add.append(str(changelog_file.relative_to(repo.working_dir)))
+
+    # Apply the new version to the source files
     files_with_new_version_written = apply_version_to_source_files(
         repo=repo,
         version_declarations=runtime.version_declarations,
         version=new_version,
         noop=opts.noop,
     )
-    all_paths_to_add = files_with_new_version_written + (assets or [])
+    all_paths_to_add.extend(files_with_new_version_written)
+    all_paths_to_add.extend(assets or [])
 
     # Build distributions before committing any changes - this way if the
     # build fails, modifications to the source code won't be committed
@@ -404,19 +462,11 @@ def version(  # noqa: C901
 
     # Commit changes
     if commit_changes and opts.noop:
-        # Indents the newlines so that terminal formatting is happy - note the
-        # git commit line of the output is 24 spaces indented too
-        # Only this message needs such special handling because of the newlines
-        # that might be in a commit message between the subject and body
-        indented_commit_message = commit_message.format(version=new_version).replace(
-            "\n\n", "\n\n" + " " * 24
-        )
         noop_report(
             indented(
                 f"""
                 would have run:
                     git add {" ".join(all_paths_to_add)}
-                    git commit -m "{indented_commit_message}"
                 """
             )
         )
@@ -432,80 +482,6 @@ def version(  # noqa: C901
             except GitCommandError:  # noqa: PERF203
                 log.warning("Failed to add path (%s) to index", updated_path)
 
-    rh = ReleaseHistory.from_git_history(
-        repo=repo,
-        translator=translator,
-        commit_parser=parser,
-        exclude_commit_patterns=changelog_excluded_commit_patterns,
-    )
-
-    commit_date = datetime.now()
-    try:
-        rh = rh.release(
-            new_version,
-            tagger=commit_author,
-            committer=commit_author,
-            tagged_date=commit_date,
-        )
-    except ValueError as ve:
-        ctx.fail(str(ve))
-
-    changelog_context = make_changelog_context(
-        hvcs_client=hvcs_client, release_history=rh
-    )
-    changelog_context.bind_to_environment(env)
-
-    updated_paths: list[str] = []
-    if update_changelog:
-        if template_dir.is_dir():
-            if opts.noop:
-                noop_report(
-                    f"would have recursively rendered the template directory "
-                    f"{template_dir!r} relative to {repo.working_dir!r}. "
-                    "Paths which would be modified by this operation cannot be "
-                    "determined in no-op mode."
-                )
-            else:
-                updated_paths = recursive_render(
-                    template_dir, environment=env, _root_dir=repo.working_dir
-                )
-
-        else:
-            log.info(
-                "Path %r not found, using default changelog template", template_dir
-            )
-            if opts.noop:
-                noop_report(
-                    "would have written your changelog to "
-                    + str(changelog_file.relative_to(repo.working_dir))
-                )
-            else:
-                changelog_text = render_default_changelog_file(env)
-                changelog_file.write_text(f"{changelog_text}\n", encoding="utf-8")
-
-            updated_paths = [str(changelog_file.relative_to(repo.working_dir))]
-
-        if commit_changes and opts.noop:
-            noop_report(
-                indented(
-                    f"""
-                    would have run:
-                        git add {" ".join(updated_paths)}
-                    """
-                )
-            )
-        elif commit_changes:
-            # Anything changed here should be staged.
-            # TODO: in future this loop should be 1 line:
-            # repo.index.add(updated_paths, force=False)  # noqa: ERA001
-            # but since 'force' is deliberally ineffective (as in docstring) in gitpython 3.1.18
-            # we have to do manually add each filepath, and catch the exception if it is an ignored file
-            for updated_path in updated_paths:
-                try:
-                    repo.git.add(updated_path)
-                except GitCommandError:  # noqa: PERF203
-                    log.warning("Failed to add path (%s) to index", updated_path)
-
     def custom_git_environment() -> ContextManager[None]:
         """
         git.custom_environment is a context manager but
@@ -541,7 +517,16 @@ def version(  # noqa: C901
             if commit_author
             else ""
         )
-        command += "git commit -m '{commit_message.format(version=v)}'"
+
+        # Indents the newlines so that terminal formatting is happy - note the
+        # git commit line of the output is 24 spaces indented too
+        # Only this message needs such special handling because of the newlines
+        # that might be in a commit message between the subject and body
+        indented_commit_message = commit_message.format(version=new_version).replace(
+            "\n\n", "\n\n" + " " * 24
+        )
+
+        command += f"git commit -m '{indented_commit_message}'"
 
         noop_report(
             indented(
@@ -600,12 +585,17 @@ def version(  # noqa: C901
                 indented(
                     f"""
                     would have run:
-                        git push --tags {runtime.masker.mask(remote_url)} {active_branch}
+                        git push {runtime.masker.mask(remote_url)} tag {new_version.as_tag()}
                     """  # noqa: E501
                 )
             )
         elif create_tag:
-            repo.git.push("--tags", remote_url, active_branch)
+            # push specific tag refspec (that we made) to remote
+            # ---------------
+            # Resolves issue #803 where a tag that already existed was pushed and caused
+            # a failure. Its not clear why there was an incorrect tag (likely user error change)
+            # but we will avoid possibly pushing an separate tag that we didn't create.
+            repo.git.push(remote_url, "tag", new_version.as_tag())
 
     gha_output.released = True
 
@@ -619,6 +609,9 @@ def version(  # noqa: C901
         # Use a new, non-configurable environment for release notes -
         # not user-configurable at the moment
         release_note_environment = environment(template_dir=runtime.template_dir)
+        changelog_context = make_changelog_context(
+            hvcs_client=hvcs_client, release_history=rh
+        )
         changelog_context.bind_to_environment(release_note_environment)
 
         template = get_release_notes_template(template_dir)

semantic_release/errors.py

@@ -31,3 +31,10 @@ class CommitParseError(SemanticReleaseBaseError):
     Raised when a commit cannot be parsed by a commit parser. Custom commit parsers
     should also raise this Exception
     """
+
+
+class MissingMergeBaseError(SemanticReleaseBaseError):
+    """
+    Raised when the merge base cannot be found with the current history. Generally
+    because of a shallow git clone.
+    """

semantic_release/version/algorithm.py

@@ -4,12 +4,10 @@ import logging
 from queue import Queue
 from typing import TYPE_CHECKING, Iterable
 
-from semantic_release.commit_parser import (
-    ParsedCommit,
-)
+from semantic_release.commit_parser import ParsedCommit
 from semantic_release.const import DEFAULT_VERSION
 from semantic_release.enums import LevelBump
-from semantic_release.errors import InvalidVersion
+from semantic_release.errors import InvalidVersion, MissingMergeBaseError
 from semantic_release.version.version import Version
 
 if TYPE_CHECKING:
@@ -278,9 +276,9 @@ def next_version(
     """
     # Step 1. All tags, sorted descending by semver ordering rules
     all_git_tags_as_versions = tags_and_versions(repo.tags, translator)
-    all_full_release_tags_and_versions = [
-        (t, v) for t, v in all_git_tags_as_versions if not v.is_prerelease
-    ]
+    all_full_release_tags_and_versions = list(
+        filter(lambda t_v: not t_v[1].is_prerelease, all_git_tags_as_versions)
+    )
     log.info(
         "Found %s full releases (excluding prereleases)",
         len(all_full_release_tags_and_versions),
@@ -291,30 +289,59 @@ def next_version(
         iter(all_full_release_tags_and_versions),
         (None, translator.from_string(DEFAULT_VERSION)),
     )
-    if latest_full_release_tag is None:
-        # Workaround - we can safely scan the extra commits on this
-        # branch if it's never been released, but we have no other
-        # guarantees that other branches exist
-        log.info(
-            "No full releases have been made yet, the default version to use is %s",
-            latest_full_release_version,
+
+    # we can safely scan the extra commits on this
+    # branch if it's never been released, but we have no other
+    # guarantees that other branches exist
+    # Note the merge_base might be on our current branch, it's not
+    # necessarily the merge base of the current branch with `main`
+    other_ref = (
+        repo.active_branch
+        if latest_full_release_tag is None
+        else latest_full_release_tag.name
+    )
+
+    # Conditional log message to inform what was chosen as the comparison point
+    # to find the merge base of the current branch with the latest full release
+    log_msg = (
+        str.join(
+            ", ",
+            [
+                "No full releases have been made yet",
+                f"the default version to use is {latest_full_release_version}",
+            ],
         )
-        merge_bases = repo.merge_base(repo.active_branch, repo.active_branch)
-    else:
-        # Note the merge_base might be on our current branch, it's not
-        # necessarily the merge base of the current branch with `main`
-        log.info(
-            "The last full release was %s, tagged as %r",
-            latest_full_release_version,
-            latest_full_release_tag,
+        if latest_full_release_tag is None
+        else str.join(
+            ", ",
+            [
+                f"The last full release was {latest_full_release_version}",
+                f"tagged as {latest_full_release_tag!r}",
+            ],
         )
-        merge_bases = repo.merge_base(latest_full_release_tag.name, repo.active_branch)
+    )
+
+    log.info(log_msg)
+    merge_bases = repo.merge_base(other_ref, repo.active_branch)
+
+    if len(merge_bases) < 1:
+        raise MissingMergeBaseError(
+            f"Unable to find merge-base between {other_ref} and {repo.active_branch.name}"
+        )
+
     if len(merge_bases) > 1:
         raise NotImplementedError(
-            "This branch has more than one merge-base with the "
-            "latest version, which is not yet supported"
+            str.join(
+                " ",
+                [
+                    "This branch has more than one merge-base with the",
+                    "latest version, which is not yet supported",
+                ],
+            )
         )
+
     merge_base = merge_bases[0]
+
     if merge_base is None:
         str_tag_name = (
             "None" if latest_full_release_tag is None else latest_full_release_tag.name
@@ -350,6 +377,23 @@ def next_version(
         tag_format=translator.tag_format,
     )
 
+    # We only include pre-releases here if doing a prerelease.
+    # If it's not a prerelease, we need to include commits back
+    # to the last full version in consideration for what kind of
+    # bump to produce. However if we're doing a prerelease, we can
+    # include prereleases here to potentially consider a smaller portion
+    # of history (from a prerelease since the last full release, onwards)
+
+    # Note that a side-effect of this is, if at some point the configuration
+    # for a particular branch pattern changes w.r.t. prerelease=True/False,
+    # the new kind of version will be produced from the commits already
+    # included in a prerelease since the last full release on the branch
+    tag_sha_2_version_lookup = {
+        tag.commit.hexsha: (tag, version)
+        for tag, version in all_git_tags_as_versions
+        if prerelease or not version.is_prerelease
+    }
+
     # N.B. these should be sorted so long as we iterate the commits in reverse order
     for commit in commits_since_last_full_release:
         parse_result = commit_parser.parse(commit)
@@ -360,44 +404,24 @@ def next_version(
             )
             parsed_levels.add(parse_result.bump)
 
-        # We only include pre-releases here if doing a prerelease.
-        # If it's not a prerelease, we need to include commits back
-        # to the last full version in consideration for what kind of
-        # bump to produce. However if we're doing a prerelease, we can
-        # include prereleases here to potentially consider a smaller portion
-        # of history (from a prerelease since the last full release, onwards)
-
-        # Note that a side-effect of this is, if at some point the configuration
-        # for a particular branch pattern changes w.r.t. prerelease=True/False,
-        # the new kind of version will be produced from the commits already
-        # included in a prerelease since the last full release on the branch
-        for tag, version in (
-            (tag, version)
-            for tag, version in all_git_tags_as_versions
-            if prerelease or not version.is_prerelease
-        ):
-            log.debug(
-                "testing if tag %r (%s) matches commit %s",
-                tag.name,
-                tag.commit.hexsha,
-                commit.hexsha,
-            )
-            if tag.commit == commit:
-                latest_version = version
-                log.debug(
-                    "tag %r (%s) matches commit %s. the latest version is %s",
-                    tag.name,
-                    tag.commit.hexsha,
-                    commit.hexsha,
-                    latest_version,
-                )
-                break
-        else:
+        log.debug("checking if commit %s matches any tags", commit.hexsha)
+        t_v = tag_sha_2_version_lookup.get(commit.hexsha, None)
+
+        if t_v is None:
             # If we haven't found the latest prerelease on the branch,
-            # keep the outer loop going to look for it
+            # keep the loop going to look for it
             log.debug("no tags correspond to commit %s", commit.hexsha)
             continue
-        # If we found it in the inner loop, break the outer loop too
+
+        # Unpack the tuple
+        tag, latest_version = t_v
+        log.debug(
+            "tag %r (%s) matches commit %s. the latest version is %s",
+            tag.name,
+            tag.commit.hexsha,
+            commit.hexsha,
+            latest_version,
+        )
         break
 
     log.debug(