python-semantic-release 9.1.1__py3-none-any.whl → 9.2.0__py3-none-any.whl

{python_semantic_release-9.1.1.dist-info → python_semantic_release-9.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-semantic-release
-Version: 9.1.1
+Version: 9.2.0
 Summary: Automatic Semantic Versioning for Python projects
 Author-email: Rolf Erik Lekang <me@rolflekang.com>
 License: MIT
@@ -21,6 +21,7 @@ Description-Content-Type: text/x-rst
 License-File: LICENSE
 License-File: AUTHORS.rst
 Requires-Dist: click <9,>=8
+Requires-Dist: click-option-group ~=0.5
 Requires-Dist: gitpython <4,>=3.0.8
 Requires-Dist: requests <3,>=2.25
 Requires-Dist: jinja2 <4,>=3.1.2

{python_semantic_release-9.1.1.dist-info → python_semantic_release-9.2.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-semantic_release/__init__.py,sha256=juZt1ZsMQ2L58yaXrSXD9QG-hYFVjolKI0vfDYJfm34,869
+semantic_release/__init__.py,sha256=VAvwW3w5b39fdfZha1JYL-fk_yvUuSj9aP7DihEURSE,869
 semantic_release/__main__.py,sha256=vXOARLV7KHeVXgpOMU0Q-8wovpdsOrtTsycxulI5xIE,106
 semantic_release/const.py,sha256=Z1o2QNh60wSLeF-_1TemMBjU3ZXbV0XghnUFsbTVfOs,831
 semantic_release/enums.py,sha256=D5B_reQGGKQQT22HO5PUtvn2Bok3fkht6TfJtXkmAUg,1020
@@ -6,21 +6,21 @@ semantic_release/errors.py,sha256=KKKCV45vvE9tla0sxYDGHkHWvqDn1gEfGIpzujcDbeI,80
 semantic_release/helpers.py,sha256=JYsAVmqF46VLONkT5t_0M5cq4zs6gNC3vzQhW3WlbN8,5571
 semantic_release/changelog/__init__.py,sha256=Bg6Xe5Vt32rWoMscW-hd4sUwiZqzWmsg4CD1EhMesMY,262
 semantic_release/changelog/context.py,sha256=ItSz5Bon2mcJkLxyQZzBTukN0zEdcaVQ4iXvz3jGCLc,986
-semantic_release/changelog/release_history.py,sha256=lphD64zgbE7IBhWoNsXP4uHOXBTuANvo27MLIMdIJOY,6594
+semantic_release/changelog/release_history.py,sha256=GpJ1aQDq46ymBUBCILInfJ4sVuZoexiEfUBqAB9FN0o,6712
 semantic_release/changelog/template.py,sha256=Vzsc2dN4_6RuykELN8lqEc4L9Gw6ibpiq4oB36kUoOU,4649
 semantic_release/cli/__init__.py,sha256=gwAYhZO-4TR0tKCkQ4GqutWsL--0CII2_dcbrElI4M4,419
-semantic_release/cli/common.py,sha256=gmMdTjTyFa6b1ISlIeljgX1UheRwmwwaoIZcXrlAOPU,1401
-semantic_release/cli/config.py,sha256=uL-VHyZ-rRbjePMECuw0-Dg5fiom5lUC3RRZUBHJkOQ,15702
+semantic_release/cli/common.py,sha256=cVQUI7Uaac_nJ7VEXuJ7Q9pVJpuMVRvE7bBl_i96g20,1439
+semantic_release/cli/config.py,sha256=9k0ms8H-A7Idpww3dDqrcuIGFFhBFHZzk-T_vx9QGmM,15822
 semantic_release/cli/const.py,sha256=S8oNNpSaKdZxcAs7PAKEjQHic0czoJBGd7XHo57FOzw,39
 semantic_release/cli/github_actions_output.py,sha256=stGWcuMtelY0qM2E_-IfofP6UvsQ6czsO7qpMfnRJI4,2102
 semantic_release/cli/masking_filter.py,sha256=DxqjiJyABlzwwwZ1r8JGQpb6QrF00StJFm0-2-s5Fv0,3071
 semantic_release/cli/util.py,sha256=toWIrjKhnuU66giiLD5anpHGg1OuVbhnPigIDt4byxA,3754
 semantic_release/cli/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-semantic_release/cli/commands/changelog.py,sha256=sc-unuM2-qtLspJIu2lv-Xh-wm42iokKMnIzmbKfPTI,4026
+semantic_release/cli/commands/changelog.py,sha256=vIJKTy8vPh7xGzJ3jEz-1z9evuJrHVg-Wqmms-c6G_k,4040
 semantic_release/cli/commands/generate_config.py,sha256=BwtwFhh80bkOUUNnR2ArC51YfPKI_y4HMD7C1oAFREA,1695
 semantic_release/cli/commands/main.py,sha256=LBbHbDNIctb35bUQsklefXVPN9bhY-LlrQFF1nNTMLg,5049
 semantic_release/cli/commands/publish.py,sha256=CvhZ4Z8CTPS-4f7kWH-xJ5JTk3jlJ-p8Mg7y2KC4SnY,1492
-semantic_release/cli/commands/version.py,sha256=7vsfxvqX7DX0fNl_qgazUkpc_3s3aK1lO6gzXpWlzPk,20886
+semantic_release/cli/commands/version.py,sha256=lFXRUPM-amJaRNSaneV5olrf6UEYN_mCeBN_y7jGssk,22416
 semantic_release/commit_parser/__init__.py,sha256=cv5HFBdw7OJd4Laj4Ex8ZZ5Tml8GwXgQcXW6Pasr2Ao,615
 semantic_release/commit_parser/_base.py,sha256=d7-sOgKn44-IG_fpJhSPZuOvkrVrMVTihfH395i3qtE,2617
 semantic_release/commit_parser/angular.py,sha256=7kp-vo3hpShHC3X3TZKHiOyXI_grLHn1hZ8L8bI3gC8,4392
@@ -28,7 +28,7 @@ semantic_release/commit_parser/emoji.py,sha256=alZL8BgMfdOQYTFwWPn9JtWD2HAoYNeHi
 semantic_release/commit_parser/scipy.py,sha256=YOO5SaE0d3R6nCg5WBCBe6Zd0hoPjBZrdRr7IHVsdSw,5776
 semantic_release/commit_parser/tag.py,sha256=Ue_XYc-Y_BWda4uMcYcOY9wU_12aw_brySMHekX4EX4,3193
 semantic_release/commit_parser/token.py,sha256=UxYAwEylPvp4x39RqNA9ITcgkaSRDEH7A5XDDJ3tdiM,1505
-semantic_release/commit_parser/util.py,sha256=2IzDkCt4FslRiUHv0iPnsgYoxBk8ZewrnPYG1DsLtQc,729
+semantic_release/commit_parser/util.py,sha256=vLcVDErZrExM55jMffos0hyMbNVQoJ-PeeVDG1Ej51I,730
 semantic_release/data/templates/CHANGELOG.md.j2,sha256=GB3YJwgVrhlcb-g5ESdEh_Gsysb_Texxv-Ip2LjulC0,1066
 semantic_release/data/templates/release_notes.md.j2,sha256=27uIHgG6iYmqdMaoWFP5LJRZcrO-3paqFzHHHsGpXXE,465
 semantic_release/hvcs/__init__.py,sha256=ulesZslSG4Lu8Iz3YzOrPXpdgvgbADq_MV17B-bSYQA,379
@@ -40,14 +40,14 @@ semantic_release/hvcs/gitlab.py,sha256=hJCTv4QC9y1iABiqJeSc0V5H8R1HZ8TRTd6ZFIKj4
 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=DetgOHAnLgOGrmIJRm_nqRl95YVcpta_Vr2UAYX9Oc8,15864
+semantic_release/version/algorithm.py,sha256=K9WkPRur0x5baXsqEi8kvaDfxduG4WNUiALXZRXujJ4,16484
 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=siyX3Cl_qhw9dTIUpafFX8-wHKW2RILVm8u6i519Pck,14183
-python_semantic_release-9.1.1.dist-info/AUTHORS.rst,sha256=XOReVvpymEFUPsS2QPH97jlfJBVrxwS2eu8-jVAe4gk,230
-python_semantic_release-9.1.1.dist-info/LICENSE,sha256=NE85nszX252sdQdu0xgS9qwfYES0k8qS6gW3uO4jRGE,1083
-python_semantic_release-9.1.1.dist-info/METADATA,sha256=bftBRdumh_mP2QpsXV8rUFqdW4mc608l4_ZszTXbpXA,5326
-python_semantic_release-9.1.1.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-python_semantic_release-9.1.1.dist-info/entry_points.txt,sha256=qojUBx_Ywf4u7KgP6NWlDaBDymZVUGQ7m5wF2duC2F0,95
-python_semantic_release-9.1.1.dist-info/top_level.txt,sha256=qYA24nyg3eP-ti5UW7Vuj2aXVmM0wqVHx4mREdRZNAA,17
-python_semantic_release-9.1.1.dist-info/RECORD,,
+python_semantic_release-9.2.0.dist-info/AUTHORS.rst,sha256=XOReVvpymEFUPsS2QPH97jlfJBVrxwS2eu8-jVAe4gk,230
+python_semantic_release-9.2.0.dist-info/LICENSE,sha256=NE85nszX252sdQdu0xgS9qwfYES0k8qS6gW3uO4jRGE,1083
+python_semantic_release-9.2.0.dist-info/METADATA,sha256=AmbbiVLWcUVLNNwMJflgWhScEq_w5eNbn8rgAPk5ZX4,5366
+python_semantic_release-9.2.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+python_semantic_release-9.2.0.dist-info/entry_points.txt,sha256=qojUBx_Ywf4u7KgP6NWlDaBDymZVUGQ7m5wF2duC2F0,95
+python_semantic_release-9.2.0.dist-info/top_level.txt,sha256=qYA24nyg3eP-ti5UW7Vuj2aXVmM0wqVHx4mREdRZNAA,17
+python_semantic_release-9.2.0.dist-info/RECORD,,

{python_semantic_release-9.1.1.dist-info → python_semantic_release-9.2.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.42.0)
+Generator: bdist_wheel (0.43.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

semantic_release/__init__.py

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

semantic_release/changelog/release_history.py

@@ -81,7 +81,9 @@ class ReleaseHistory:
                     if isinstance(tag.object, TagObject):
                         tagger = tag.object.tagger
                         committer = tag.object.tagger.committer()
-                        _tz = timezone(timedelta(seconds=tag.object.tagger_tz_offset))
+                        _tz = timezone(
+                            timedelta(seconds=-1 * tag.object.tagger_tz_offset)
+                        )
                         tagged_date = datetime.fromtimestamp(
                             tag.object.tagged_date, tz=_tz
                         )
@@ -89,7 +91,9 @@ class ReleaseHistory:
                         # For some reason, sometimes tag.object is a Commit
                         tagger = tag.object.author
                         committer = tag.object.author
-                        _tz = timezone(timedelta(seconds=tag.object.author_tz_offset))
+                        _tz = timezone(
+                            timedelta(seconds=-1 * tag.object.author_tz_offset)
+                        )
                         tagged_date = datetime.fromtimestamp(
                             tag.object.committed_date, tz=_tz
                         )

semantic_release/cli/commands/changelog.py

@@ -67,7 +67,7 @@ def changelog(ctx: click.Context, release_tag: str | None = None) -> None:
             )
         else:
             changelog_text = render_default_changelog_file(env)
-            changelog_file.write_text(changelog_text, encoding="utf-8")
+            changelog_file.write_text(f"{changelog_text}\n", encoding="utf-8")
 
     else:
         if runtime.global_cli_options.noop:
@@ -112,7 +112,7 @@ def changelog(ctx: click.Context, release_tag: str | None = None) -> None:
         else:
             try:
                 hvcs_client.create_or_update_release(
-                    release_tag, release_notes, prerelease=version.is_prerelease
+                    release_tag, f"{release_notes}\n", prerelease=version.is_prerelease
                 )
             except Exception as e:
                 log.exception(e)

semantic_release/cli/commands/version.py

@@ -9,6 +9,7 @@ from typing import TYPE_CHECKING, ContextManager, Iterable
 
 import click
 import shellingham  # type: ignore[import]
+from click_option_group import MutuallyExclusiveOptionGroup, optgroup
 from git.exc import GitCommandError
 
 from semantic_release.changelog import ReleaseHistory, environment, recursive_render
@@ -26,8 +27,9 @@ from semantic_release.version import Version, next_version, tags_and_versions
 
 log = logging.getLogger(__name__)
 
-if TYPE_CHECKING:
+if TYPE_CHECKING:  # pragma: no cover
     from git import Repo
+    from git.refs.tag import Tag
 
     from semantic_release.cli.config import RuntimeContext
     from semantic_release.version import VersionTranslator
@@ -48,6 +50,13 @@ def is_forced_prerelease(
     return force_prerelease or ((force_level is None) and prerelease)
 
 
+def last_released(
+    repo: Repo, translator: VersionTranslator
+) -> tuple[Tag, Version] | None:
+    ts_and_vs = tags_and_versions(repo.tags, translator)
+    return ts_and_vs[0] if ts_and_vs else None
+
+
 def version_from_forced_level(
     repo: Repo, level_bump: LevelBump, translator: VersionTranslator
 ) -> Version:
@@ -111,9 +120,26 @@ def shell(cmd: str, *, check: bool = True) -> subprocess.CompletedProcess:
         "help_option_names": ["-h", "--help"],
     },
 )
-@click.option(
+@optgroup.group("Print flags", cls=MutuallyExclusiveOptionGroup)
+@optgroup.option(
     "--print", "print_only", is_flag=True, help="Print the next version and exit"
 )
+@optgroup.option(
+    "--print-tag",
+    "print_only_tag",
+    is_flag=True,
+    help="Print the next version tag and exit",
+)
+@optgroup.option(
+    "--print-last-released",
+    is_flag=True,
+    help="Print the last released version and exit",
+)
+@optgroup.option(
+    "--print-last-released-tag",
+    is_flag=True,
+    help="Print the last released version tag and exit",
+)
 @click.option(
     "--prerelease",
     "force_prerelease",
@@ -191,6 +217,9 @@ def shell(cmd: str, *, check: bool = True) -> subprocess.CompletedProcess:
 def version(  # noqa: C901
     ctx: click.Context,
     print_only: bool = False,
+    print_only_tag: bool = False,
+    print_last_released: bool = False,
+    print_last_released_tag: bool = False,
     force_prerelease: bool = False,
     prerelease_token: str | None = None,
     force_level: str | None = None,
@@ -219,8 +248,20 @@ def version(  # noqa: C901
     """
     runtime: RuntimeContext = ctx.obj
     repo = runtime.repo
-    parser = runtime.commit_parser
     translator = runtime.version_translator
+
+    # We can short circuit updating the release if we are only printing the last released version
+    if print_last_released or print_last_released_tag:
+        if last_release := last_released(repo, translator):
+            if print_last_released:
+                click.echo(last_release[1])
+            if print_last_released_tag:
+                click.echo(last_release[0])
+        else:
+            log.warning("No release tags found.")
+        ctx.exit(0)
+
+    parser = runtime.commit_parser
     prerelease = is_forced_prerelease(
         force_prerelease=force_prerelease,
         force_level=force_level,
@@ -291,6 +332,7 @@ def version(  # noqa: C901
             commit_parser=parser,
             prerelease=prerelease,
             major_on_zero=major_on_zero,
+            allow_zero_version=runtime.allow_zero_version,
         )
 
     if build_metadata:
@@ -301,7 +343,10 @@ def version(  # noqa: C901
     ctx.call_on_close(gha_output.write_if_possible)
 
     # Print the new version so that command-line output capture will work
-    click.echo(str(new_version))
+    if print_only_tag:
+        click.echo(translator.str_to_tag(str(new_version)))
+    else:
+        click.echo(str(new_version))
 
     # If the new version has already been released, we fail and abort if strict;
     # otherwise we exit with 0.
@@ -318,7 +363,7 @@ def version(  # noqa: C901
             )
             ctx.exit(0)
 
-    if print_only:
+    if print_only or print_only_tag:
         ctx.exit(0)
 
     rprint(f"[bold green]The next version is: [white]{new_version!s}[/white]! :rocket:")
@@ -429,7 +474,7 @@ def version(  # noqa: C901
                 )
             else:
                 changelog_text = render_default_changelog_file(env)
-                changelog_file.write_text(changelog_text, encoding="utf-8")
+                changelog_file.write_text(f"{changelog_text}\n", encoding="utf-8")
 
             updated_paths = [str(changelog_file.relative_to(repo.working_dir))]
 

semantic_release/cli/common.py

@@ -34,7 +34,7 @@ def render_default_changelog_file(template_environment: Environment) -> str:
         .read_text(encoding="utf-8")
     )
     tmpl = template_environment.from_string(changelog_text)
-    return tmpl.render()
+    return tmpl.render().rstrip()
 
 
 def render_release_notes(
@@ -43,6 +43,8 @@ def render_release_notes(
     version: Version,
     release: Release,
 ) -> str:
-    return template_environment.from_string(release_notes_template).render(
-        version=version, release=release
+    return (
+        template_environment.from_string(release_notes_template)
+        .render(version=version, release=release)
+        .rstrip()
     )

semantic_release/cli/config.py

@@ -145,6 +145,7 @@ class RawConfig(BaseModel):
     commit_parser_options: Dict[str, Any] = {}
     logging_use_named_masks: bool = False
     major_on_zero: bool = True
+    allow_zero_version: bool = True
     remote: RemoteConfig = RemoteConfig()
     tag_format: str = "v{version}"
     publish: PublishConfig = PublishConfig()
@@ -229,6 +230,7 @@ class RuntimeContext:
     commit_parser: CommitParser[ParseResult, ParserOptions]
     version_translator: VersionTranslator
     major_on_zero: bool
+    allow_zero_version: bool
     prerelease: bool
     assets: List[str]
     commit_author: Actor
@@ -414,6 +416,7 @@ class RuntimeContext:
             commit_parser=commit_parser,
             version_translator=version_translator,
             major_on_zero=raw.major_on_zero,
+            allow_zero_version=raw.allow_zero_version,
             build_command=raw.build_command,
             version_declarations=tuple(version_declarations),
             hvcs_client=hvcs_client,

semantic_release/commit_parser/util.py

@@ -6,7 +6,7 @@ breaking_re = re.compile(r"BREAKING[ -]CHANGE:\s?(.*)")
 
 
 def parse_paragraphs(text: str) -> list[str]:
-    """
+    r"""
     This will take a text block and return a list containing each
     paragraph with single line breaks collapsed into spaces.
 

semantic_release/version/algorithm.py

@@ -143,6 +143,7 @@ def _increment_version(
     prerelease: bool,
     prerelease_token: str,
     major_on_zero: bool,
+    allow_zero_version: bool,
 ) -> Version:
     """
     Using the given versions, along with a given `level_bump`, increment to
@@ -158,19 +159,27 @@ def _increment_version(
     `latest_full_version_in_history`, correspondingly, is the latest full release which
     is in this branch's history.
     """
-    log.debug(
-        "_increment_version: %s", ", ".join(f"{k} = {v}" for k, v in locals().items())
-    )
-    if not major_on_zero and latest_version.major == 0:
-        # if we are a 0.x.y release and have set `major_on_zero`,
-        # breaking changes should increment the minor digit
-        # Correspondingly, we reduce the level that we increment the
-        # version by.
-        log.debug(
-            "reducing version increment due to 0. version and major_on_zero=False"
-        )
+    local_vars = list(locals().items())
+    log.debug("_increment_version: %s", ", ".join(f"{k} = {v}" for k, v in local_vars))
+    if latest_version.major == 0:
+        if not allow_zero_version:
+            # Set up default version to be 1.0.0 if currently 0.x.x which means a commented
+            # breaking change is not required to bump to 1.0.0
+            log.debug(
+                "Bumping major version as 0.x.x versions are disabled because of allow_zero_version=False"
+            )
+            level_bump = LevelBump.MAJOR
+
+        elif not major_on_zero:
+            # if we are a 0.x.y release and have set `major_on_zero`,
+            # breaking changes should increment the minor digit
+            # Correspondingly, we reduce the level that we increment the
+            # version by.
+            log.debug(
+                "reducing version increment due to 0. version and major_on_zero=False"
+            )
 
-        level_bump = min(level_bump, LevelBump.MINOR)
+            level_bump = min(level_bump, LevelBump.MINOR)
 
     if prerelease:
         log.debug("prerelease=true")
@@ -261,6 +270,7 @@ def next_version(
     commit_parser: CommitParser[ParseResult, ParserOptions],
     prerelease: bool = False,
     major_on_zero: bool = True,
+    allow_zero_version: bool = True,
 ) -> Version:
     """
     Evaluate the history within `repo`, and based on the tags and commits in the repo
@@ -398,8 +408,9 @@ def next_version(
     level_bump = max(parsed_levels, default=LevelBump.NO_RELEASE)
     log.info("The type of the next release release is: %s", level_bump)
     if level_bump is LevelBump.NO_RELEASE:
-        log.info("No release will be made")
-        return latest_version
+        if latest_version.major != 0 or allow_zero_version:
+            log.info("No release will be made")
+            return latest_version
 
     return _increment_version(
         latest_version=latest_version,
@@ -418,4 +429,5 @@ def next_version(
         prerelease=prerelease,
         prerelease_token=translator.prerelease_token,
         major_on_zero=major_on_zero,
+        allow_zero_version=allow_zero_version,
     )