python-semantic-release 8.0.0a6__tar.gz → 8.0.0a7__tar.gz

{python-semantic-release-8.0.0a6/python_semantic_release.egg-info → python-semantic-release-8.0.0a7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-semantic-release
-Version: 8.0.0a6
+Version: 8.0.0a7
 Summary: Automatic Semantic Versioning for Python projects
 Author-email: Rolf Erik Lekang <me@rolflekang.com>
 License: MIT

{python-semantic-release-8.0.0a6 → python-semantic-release-8.0.0a7}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-semantic-release"
-version = "8.0.0-alpha.6"
+version = "8.0.0-alpha.7"
 description = "Automatic Semantic Versioning for Python projects"
 requires-python = ">=3.7"
 license = { text = "MIT" }
@@ -37,6 +37,7 @@ dependencies = [
 
 [project.scripts]
 semantic-release = "semantic_release.cli:main"
+psr = "semantic_release.cli:main"
 
 [project.urls]
 "Project Url" = "http://github.com/python-semantic-release/python-semantic-release"
@@ -47,6 +48,7 @@ docs = [
   "Sphinx==5.2.3",
   "sphinxcontrib-apidoc==0.3.0",
   "sphinx-autobuild==2021.03.14",
+  "furo>=2023.5.20",
 ]
 test = [
   "coverage[toml]>=6,<7",

{python-semantic-release-8.0.0a6 → python-semantic-release-8.0.0a7/python_semantic_release.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-semantic-release
-Version: 8.0.0a6
+Version: 8.0.0a7
 Summary: Automatic Semantic Versioning for Python projects
 Author-email: Rolf Erik Lekang <me@rolflekang.com>
 License: MIT

{python-semantic-release-8.0.0a6 → python-semantic-release-8.0.0a7}/python_semantic_release.egg-info/SOURCES.txt

@@ -61,6 +61,7 @@ tests/command_line/test_changelog.py
 tests/command_line/test_generate_config.py
 tests/command_line/test_help.py
 tests/command_line/test_main.py
+tests/command_line/test_publish.py
 tests/command_line/test_version.py
 tests/fixtures/__init__.py
 tests/fixtures/commit_parsers.py

{python-semantic-release-8.0.0a6 → python-semantic-release-8.0.0a7}/python_semantic_release.egg-info/entry_points.txt

@@ -1,2 +1,3 @@
 [console_scripts]
+psr = semantic_release.cli:main
 semantic-release = semantic_release.cli:main

{python-semantic-release-8.0.0a6 → python-semantic-release-8.0.0a7}/python_semantic_release.egg-info/requires.txt

@@ -22,6 +22,7 @@ black
 Sphinx==5.2.3
 sphinxcontrib-apidoc==0.3.0
 sphinx-autobuild==2021.03.14
+furo>=2023.5.20
 
 [mypy]
 mypy

{python-semantic-release-8.0.0a6 → python-semantic-release-8.0.0a7}/semantic_release/__init__.py

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

{python-semantic-release-8.0.0a6 → python-semantic-release-8.0.0a7}/semantic_release/cli/commands/main.py

@@ -54,12 +54,20 @@ FORMAT = "[%(name)s] %(levelname)s %(module)s.%(funcName)s: %(message)s"
     show_default=True,
     type=click.IntRange(0, 2, clamp=True),
 )
+@click.option(
+    "--strict",
+    "strict",
+    is_flag=True,
+    default=False,
+    help="Enable strict mode",
+)
 @click.pass_context
 def main(
     ctx: click.Context,
     config_file: str = DEFAULT_CONFIG_FILE,
     verbosity: int = 0,
     noop: bool = False,
+    strict: bool = False,
 ) -> None:
     """
     Python Semantic Release
@@ -106,9 +114,14 @@ def main(
             ":shield: [bold cyan]You are running in no-operation mode, because the "
             "'--noop' flag was supplied"
         )
+
     cli_options = GlobalCommandLineOptions(
-        noop=noop, verbosity=verbosity, config_file=config_file
+        noop=noop,
+        verbosity=verbosity,
+        config_file=config_file,
+        strict=strict,
     )
+    log.debug("global cli options: %s", cli_options)
 
     try:
         if config_file.endswith(".toml"):
@@ -130,8 +143,11 @@ def main(
             raw_config, repo=repo, global_cli_options=cli_options
         )
     except NotAReleaseBranch as exc:
-        rprint(f"[bold red]{str(exc)}")
-        ctx.exit(2)
+        rprint(f"[bold {'red' if strict else 'orange1'}]{str(exc)}")
+        # If not strict, exit 0 so other processes can continue. For example, in
+        # multibranch CI it might be desirable to run a non-release branch's pipeline
+        # without specifying conditional execution of PSR based on branch name
+        ctx.exit(2 if strict else 0)
     except InvalidConfiguration as exc:
         ctx.fail(str(exc))
     ctx.obj = runtime

{python-semantic-release-8.0.0a6 → python-semantic-release-8.0.0a7}/semantic_release/cli/commands/publish.py

@@ -14,8 +14,14 @@ log = logging.getLogger(__name__)
         "help_option_names": ["-h", "--help"],
     },
 )
+@click.option(
+    "--tag",
+    "tag",
+    help="The tag associated with the release to publish to",
+    default="latest",
+)
 @click.pass_context
-def publish(ctx: click.Context) -> None:
+def publish(ctx: click.Context, tag: str = "latest") -> None:
     """
     Build and publish a distribution to a VCS release.
     """
@@ -25,7 +31,8 @@ def publish(ctx: click.Context) -> None:
     translator = runtime.version_translator
     dist_glob_patterns = runtime.dist_glob_patterns
 
-    latest_tag = tags_and_versions(repo.tags, translator)[0][0]
+    if tag == "latest":
+        tag = str(tags_and_versions(repo.tags, translator)[0][0])
     if runtime.global_cli_options.noop:
         noop_report(
             "would have uploaded files matching any of the globs "
@@ -36,4 +43,4 @@ def publish(ctx: click.Context) -> None:
 
     log.info("Uploading distributions to release")
     for pattern in dist_glob_patterns:
-        hvcs_client.upload_dists(tag=latest_tag, dist_glob=pattern)
+        hvcs_client.upload_dists(tag=tag, dist_glob=pattern)

{python-semantic-release-8.0.0a6 → python-semantic-release-8.0.0a7}/semantic_release/cli/commands/version.py

@@ -172,6 +172,13 @@ def shell(cmd: str, *, check: bool = True) -> subprocess.CompletedProcess:
     default=os.getenv("PSR_BUILD_METADATA"),
     help="Build metadata to append to the new version",
 )
+@click.option(
+    "--skip-build",
+    "skip_build",
+    default=False,
+    is_flag=True,
+    help="Skip building the current project",
+)
 @click.pass_context
 def version(
     ctx: click.Context,
@@ -184,6 +191,7 @@ def version(
     push_changes: bool = True,
     make_vcs_release: bool = True,
     build_metadata: str | None = None,
+    skip_build: bool = False,
 ) -> str:
     """
     Detect the semantically correct next version that should be applied to your
@@ -278,14 +286,24 @@ def version(
 
     gha_output.released = False
     gha_output.version = new_version
-    # If the new version has already been released, we fail and abort
+
+    # Print the new version so that command-line output capture will work
+    click.echo(str(new_version))
+
+    # If the new version has already been released, we fail and abort if strict;
+    # otherwise we exit with 0.
     if new_version in {v for _, v in tags_and_versions(repo.tags, translator)}:
-        ctx.fail(
-            f"No release will be made, {str(new_version)} has already been released!"
-        )
+        if opts.strict:
+            ctx.fail(
+                f"No release will be made, {str(new_version)} has already been released!"
+            )
+        else:
+            rprint(
+                f"[bold orange1]No release will be made, {str(new_version)} has already been released!"
+            )
+            ctx.exit(0)
 
     if print_only:
-        click.echo(str(new_version))
         ctx.exit(0)
 
     rprint(
@@ -302,9 +320,11 @@ def version(
 
     # Build distributions before committing any changes - this way if the
     # build fails, modifications to the source code won't be committed
-    if not build_command:
+    if skip_build:
+        rprint("[bold orange1]Skipping build due to --skip-build flag")
+    elif not build_command:
         rprint("[green]No build command specified, skipping")
-    if runtime.global_cli_options.noop:
+    elif runtime.global_cli_options.noop:
         noop_report(f"would have run the build_command {build_command}")
     else:
         try:

{python-semantic-release-8.0.0a6 → python-semantic-release-8.0.0a7}/semantic_release/cli/config.py

@@ -171,6 +171,7 @@ class GlobalCommandLineOptions:
     noop: bool = False
     verbosity: int = 0
     config_file: str = DEFAULT_CONFIG_FILE
+    strict: bool = False
 
 
 ######

python-semantic-release-8.0.0a7/tests/command_line/test_main.py

@@ -0,0 +1,32 @@
+import pytest
+
+from semantic_release import __version__
+from semantic_release.cli import main
+
+
+def test_main_prints_version_and_exits(cli_runner):
+    result = cli_runner.invoke(main, ["--version"])
+    assert result.exit_code == 0
+    assert result.output == f"semantic-release, version {__version__}\n"
+
+
+@pytest.mark.parametrize("args", [[], ["--help"]])
+def test_main_prints_help_text(cli_runner, args):
+    result = cli_runner.invoke(main, args)
+    assert result.exit_code == 0
+
+
+def test_not_a_release_branch_exit_code(repo_with_git_flow_angular_commits, cli_runner):
+    # Run anything that doesn't trigger the help text
+    repo_with_git_flow_angular_commits.git.checkout("-b", "branch-does-not-exist")
+    result = cli_runner.invoke(main, ["version", "--no-commit"])
+    assert result.exit_code == 0
+
+
+def test_not_a_release_branch_exit_code_with_strict(
+    repo_with_git_flow_angular_commits, cli_runner
+):
+    # Run anything that doesn't trigger the help text
+    repo_with_git_flow_angular_commits.git.checkout("-b", "branch-does-not-exist")
+    result = cli_runner.invoke(main, ["--strict", "version", "--no-commit"])
+    assert result.exit_code != 0

python-semantic-release-8.0.0a7/tests/command_line/test_publish.py

@@ -0,0 +1,37 @@
+from unittest import mock
+
+import pytest
+
+from semantic_release.cli import main, publish
+from semantic_release.hvcs import Github
+from semantic_release.version import tags_and_versions
+
+
+@pytest.mark.parametrize("cmd_args", [(), ("--tag", "latest")])
+def test_publish_latest_uses_latest_tag(
+    repo_with_single_branch_angular_commits,
+    cli_runner,
+    cmd_args,
+):
+    with mock.patch.object(Github, "upload_dists") as mocked_upload_dists, mock.patch(
+        "semantic_release.cli.commands.publish.tags_and_versions",
+        return_value=([("v1.0.0", "1.0.0")]),
+    ) as mock_tags_and_versions:
+        result = cli_runner.invoke(main, [publish.name, *cmd_args])
+        assert result.exit_code == 0
+
+    mock_tags_and_versions.assert_called_once()
+    mocked_upload_dists.assert_called_once_with(tag="v1.0.0", dist_glob="dist/*")
+
+
+def test_publish_to_tag_uses_tag(repo_with_single_branch_angular_commits, cli_runner):
+    tag = "v99.999.9999+build.1234"
+    with mock.patch.object(Github, "upload_dists") as mocked_upload_dists, mock.patch(
+        "semantic_release.cli.commands.publish.tags_and_versions",
+        return_value=([("v1.0.0", "1.0.0")]),
+    ) as mock_tags_and_versions:
+        result = cli_runner.invoke(main, [publish.name, "--tag", tag])
+        assert result.exit_code == 0
+
+    mock_tags_and_versions.assert_not_called()
+    assert mocked_upload_dists.called_once_with(tag=tag, dist_glob="dist/*")

{python-semantic-release-8.0.0a6 → python-semantic-release-8.0.0a7}/tests/command_line/test_version.py

@@ -3,7 +3,6 @@ from __future__ import annotations
 import difflib
 import filecmp
 import re
-import shlex
 import shutil
 from subprocess import CompletedProcess
 from unittest import mock
@@ -240,7 +239,7 @@ def test_version_already_released_no_push(repo, cli_runner):
     # In these tests, unless arguments are supplied then the latest version
     # has already been released, so we expect an exit code of 2 with the message
     # to indicate that no release will be made
-    result = cli_runner.invoke(main, [version.name, "--no-push"])
+    result = cli_runner.invoke(main, ["--strict", version.name, "--no-push"])
     assert result.exit_code == 2
     assert "no release will be made" in result.output.lower()
 
@@ -440,168 +439,6 @@ def test_version_no_push_force_level(
     assert added == [f'__version__ = "{expected_new_version}"\n']
 
 
-@pytest.mark.parametrize(
-    "repo, cli_args, expected_stdout",
-    [
-        *[
-            (
-                lazy_fixture("repo_with_no_tags_angular_commits"),
-                cli_args,
-                expected_stdout,
-            )
-            for cli_args, expected_stdout in (
-                ([], "0.1.0"),
-                (["--build-metadata", "build.12345"], "0.1.0+build.12345"),
-                (["--patch"], "0.0.1"),
-                (["--minor"], "0.1.0"),
-                (["--major"], "1.0.0"),
-                (["--patch", "--prerelease"], "0.0.1-rc.1"),
-                (["--minor", "--prerelease"], "0.1.0-rc.1"),
-                (["--major", "--prerelease"], "1.0.0-rc.1"),
-                (
-                    ["--patch", "--prerelease", "--prerelease-token", "beta"],
-                    "0.0.1-beta.1",
-                ),
-            )
-        ],
-        *[
-            (
-                lazy_fixture("repo_with_single_branch_angular_commits"),
-                cli_args,
-                expected_stdout,
-            )
-            for cli_args, expected_stdout in (
-                ([], "0.1.2"),
-                (["--build-metadata", "build.12345"], "0.1.2+build.12345"),
-                (["--patch"], "0.1.2"),
-                (["--minor"], "0.2.0"),
-                (["--major"], "1.0.0"),
-                (["--patch", "--prerelease"], "0.1.2-rc.1"),
-                (["--minor", "--prerelease"], "0.2.0-rc.1"),
-                (["--major", "--prerelease"], "1.0.0-rc.1"),
-                (
-                    ["--patch", "--prerelease", "--prerelease-token", "beta"],
-                    "0.1.2-beta.1",
-                ),
-            )
-        ],
-        *[
-            (
-                lazy_fixture("repo_with_single_branch_and_prereleases_angular_commits"),
-                cli_args,
-                expected_stdout,
-            )
-            for cli_args, expected_stdout in (
-                ([], "0.2.1"),
-                (["--build-metadata", "build.12345"], "0.2.1+build.12345"),
-                (["--patch"], "0.2.1"),
-                (["--minor"], "0.3.0"),
-                (["--major"], "1.0.0"),
-                (["--patch", "--prerelease"], "0.2.1-rc.1"),
-                (["--minor", "--prerelease"], "0.3.0-rc.1"),
-                (["--major", "--prerelease"], "1.0.0-rc.1"),
-                (
-                    ["--patch", "--prerelease", "--prerelease-token", "beta"],
-                    "0.2.1-beta.1",
-                ),
-            )
-        ],
-        *[
-            (
-                lazy_fixture("repo_with_main_and_feature_branches_angular_commits"),
-                cli_args,
-                expected_stdout,
-            )
-            for cli_args, expected_stdout in (
-                ([], "0.3.0-beta.2"),
-                (["--build-metadata", "build.12345"], "0.3.0-beta.2+build.12345"),
-                (["--patch"], "0.3.1"),
-                (["--minor"], "0.4.0"),
-                (["--major"], "1.0.0"),
-                (["--patch", "--prerelease"], "0.3.1-beta.1"),
-                (["--minor", "--prerelease"], "0.4.0-beta.1"),
-                (["--major", "--prerelease"], "1.0.0-beta.1"),
-                (
-                    ["--patch", "--prerelease", "--prerelease-token", "beta"],
-                    "0.3.1-beta.1",
-                ),
-            )
-        ],
-        *[
-            (
-                lazy_fixture("repo_with_git_flow_angular_commits"),
-                cli_args,
-                expected_stdout,
-            )
-            for cli_args, expected_stdout in (
-                ([], "1.2.0-alpha.3"),
-                (["--build-metadata", "build.12345"], "1.2.0-alpha.3+build.12345"),
-                (["--patch"], "1.2.1"),
-                (["--minor"], "1.3.0"),
-                (["--major"], "2.0.0"),
-                (["--patch", "--prerelease"], "1.2.1-alpha.1"),
-                (["--minor", "--prerelease"], "1.3.0-alpha.1"),
-                (["--major", "--prerelease"], "2.0.0-alpha.1"),
-                (
-                    ["--patch", "--prerelease", "--prerelease-token", "beta"],
-                    "1.2.1-beta.1",
-                ),
-            )
-        ],
-        *[
-            (
-                lazy_fixture("repo_with_git_flow_and_release_channels_angular_commits"),
-                cli_args,
-                expected_stdout,
-            )
-            for cli_args, expected_stdout in (
-                ([], "1.1.0-alpha.4"),
-                (["--build-metadata", "build.12345"], "1.1.0-alpha.4+build.12345"),
-                (["--patch"], "1.1.1"),
-                (["--minor"], "1.2.0"),
-                (["--major"], "2.0.0"),
-                (["--patch", "--prerelease"], "1.1.1-alpha.1"),
-                (["--minor", "--prerelease"], "1.2.0-alpha.1"),
-                (["--major", "--prerelease"], "2.0.0-alpha.1"),
-                (
-                    ["--patch", "--prerelease", "--prerelease-token", "beta"],
-                    "1.1.1-beta.1",
-                ),
-            )
-        ],
-    ],
-)
-def test_version_print(
-    repo, cli_args, expected_stdout, example_project, tmp_path_factory, cli_runner
-):
-    # Make a commit to ensure we have something to release
-    # otherwise the "no release will be made" logic will kick in first
-    new_file = example_project / "temp.txt"
-    new_file.write_text("noop version test")
-
-    repo.git.add(str(new_file.resolve()))
-    repo.git.commit(m="fix: temp new file")
-
-    tempdir = tmp_path_factory.mktemp("test_version_print")
-    shutil.rmtree(str(tempdir.resolve()))
-    shutil.copytree(src=str(example_project.resolve()), dst=tempdir)
-    head_before = repo.head.commit
-    tags_before = sorted(list(repo.tags), key=lambda tag: tag.name)
-
-    result = cli_runner.invoke(main, [version.name, *cli_args, "--print"])
-
-    tags_after = sorted(list(repo.tags), key=lambda tag: tag.name)
-    head_after = repo.head.commit
-
-    assert result.exit_code == 0
-    assert tags_before == tags_after
-    assert head_before == head_after
-    assert result.output.rstrip("\n") == expected_stdout
-    dcmp = filecmp.dircmp(str(example_project.resolve()), tempdir)
-    differing_files = flatten_dircmp(dcmp)
-    assert not differing_files
-
-
 @pytest.mark.parametrize(
     "repo",
     [
@@ -614,7 +451,9 @@ def test_version_print(
 )
 def test_version_build_metadata_triggers_new_version(repo, cli_runner):
     # Verify we get "no version to release" without build metadata
-    no_metadata_result = cli_runner.invoke(main, [version.name, "--no-push"])
+    no_metadata_result = cli_runner.invoke(
+        main, ["--strict", version.name, "--no-push"]
+    )
     assert no_metadata_result.exit_code == 2
     assert "no release will be made" in no_metadata_result.output.lower()
 
@@ -648,6 +487,20 @@ def test_version_runs_build_command(
         )
 
 
+def test_version_skips_build_command_with_skip_build(
+    repo_with_git_flow_angular_commits, cli_runner
+):
+    with mock.patch(
+        "subprocess.run", return_value=CompletedProcess(args=(), returncode=0)
+    ) as patched_subprocess_run:
+        result = cli_runner.invoke(
+            main, [version.name, "--patch", "--no-push", "--skip-build"]
+        )  # force a new version
+        assert result.exit_code == 0
+
+        patched_subprocess_run.assert_not_called()
+
+
 def test_version_writes_github_actions_output(
     repo_with_git_flow_angular_commits, cli_runner, monkeypatch, tmp_path
 ):
@@ -665,3 +518,16 @@ def test_version_writes_github_actions_output(
     assert action_outputs["version"] == "1.2.1"
     assert "tag" in action_outputs
     assert action_outputs["tag"] == "v1.2.1"
+
+
+def test_version_exit_code_when_strict(repo_with_git_flow_angular_commits, cli_runner):
+    result = cli_runner.invoke(main, ["--strict", version.name, "--no-push"])
+    assert result.exit_code != 0
+
+
+def test_version_exit_code_when_not_strict(
+    repo_with_git_flow_angular_commits, cli_runner
+):
+    # Testing "no release will be made"
+    result = cli_runner.invoke(main, [version.name, "--no-push"])
+    assert result.exit_code == 0

{python-semantic-release-8.0.0a6 → python-semantic-release-8.0.0a7}/tests/unit/semantic_release/cli/test_config.py

@@ -2,7 +2,6 @@ from unittest import mock
 
 import pytest
 import tomlkit
-from git import Repo
 
 from semantic_release.cli.config import (
     GlobalCommandLineOptions,

python-semantic-release-8.0.0a6/tests/command_line/test_main.py

@@ -1,18 +0,0 @@
-import logging
-
-import pytest
-
-from semantic_release import __version__
-from semantic_release.cli import main
-
-
-def test_main_prints_version_and_exits(cli_runner):
-    result = cli_runner.invoke(main, ["--version"])
-    assert result.exit_code == 0
-    assert result.output == f"semantic-release, version {__version__}\n"
-
-
-@pytest.mark.parametrize("args", [[], ["--help"]])
-def test_main_prints_help_text(cli_runner, args):
-    result = cli_runner.invoke(main, args)
-    assert result.exit_code == 0