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

{python-semantic-release-8.0.0a5/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.0a5
+Version: 8.0.0a7
 Summary: Automatic Semantic Versioning for Python projects
 Author-email: Rolf Erik Lekang <me@rolflekang.com>
 License: MIT
@@ -53,7 +53,15 @@ Read more about the setup and configuration in our `getting started guide`_.
 .. _GitHub Action: https://python-semantic-release.readthedocs.io/en/latest/automatic-releases/github-actions.html
 .. _conda-forge: https://anaconda.org/conda-forge/python-semantic-release
 
-.. |Test Status| image:: https://img.shields.io/github/workflow/status/relekang/python-semantic-release/Test%20%26%20Release?label=Tests&logo=github
+.. |Test Status| image:: https://img.shields.io/github/actions/workflow/status/python-semantic-release/python-semantic-release/main.yml?branch=master&label=Test%20Status&logo=github
+   :target: https://github.com/python-semantic-release/python-semantic-release/actions/workflows/main.yml
+   :alt: test-status
 .. |PyPI Version| image:: https://img.shields.io/pypi/v/python-semantic-release?label=PyPI&logo=pypi
+   :target: https://pypi.org/project/python-semantic-release/
+   :alt: pypi
 .. |conda-forge Version| image:: https://img.shields.io/conda/vn/conda-forge/python-semantic-release?logo=anaconda
-.. |Read the Docs Status| image:: https://img.shields.io/readthedocs/python-semantic-release?label=Read%20the%20Docs&logo=read-the-docs
+   :target: https://anaconda.org/conda-forge/python-semantic-release
+   :alt: conda-forge
+.. |Read the Docs Status| image:: https://img.shields.io/readthedocs/python-semantic-release?label=Read%20the%20Docs&logo=Read%20the%20Docs
+   :target: https://python-semantic-release.readthedocs.io/en/latest/
+   :alt: docs

{python-semantic-release-8.0.0a5 → python-semantic-release-8.0.0a7}/README.rst

@@ -30,7 +30,15 @@ Read more about the setup and configuration in our `getting started guide`_.
 .. _GitHub Action: https://python-semantic-release.readthedocs.io/en/latest/automatic-releases/github-actions.html
 .. _conda-forge: https://anaconda.org/conda-forge/python-semantic-release
 
-.. |Test Status| image:: https://img.shields.io/github/workflow/status/relekang/python-semantic-release/Test%20%26%20Release?label=Tests&logo=github
+.. |Test Status| image:: https://img.shields.io/github/actions/workflow/status/python-semantic-release/python-semantic-release/main.yml?branch=master&label=Test%20Status&logo=github
+   :target: https://github.com/python-semantic-release/python-semantic-release/actions/workflows/main.yml
+   :alt: test-status
 .. |PyPI Version| image:: https://img.shields.io/pypi/v/python-semantic-release?label=PyPI&logo=pypi
+   :target: https://pypi.org/project/python-semantic-release/
+   :alt: pypi
 .. |conda-forge Version| image:: https://img.shields.io/conda/vn/conda-forge/python-semantic-release?logo=anaconda
-.. |Read the Docs Status| image:: https://img.shields.io/readthedocs/python-semantic-release?label=Read%20the%20Docs&logo=read-the-docs
+   :target: https://anaconda.org/conda-forge/python-semantic-release
+   :alt: conda-forge
+.. |Read the Docs Status| image:: https://img.shields.io/readthedocs/python-semantic-release?label=Read%20the%20Docs&logo=Read%20the%20Docs
+   :target: https://python-semantic-release.readthedocs.io/en/latest/
+   :alt: docs

{python-semantic-release-8.0.0a5 → 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.5"
+version = "8.0.0-alpha.7"
 description = "Automatic Semantic Versioning for Python projects"
 requires-python = ">=3.7"
 license = { text = "MIT" }
@@ -23,7 +23,6 @@ authors = [{ name = "Rolf Erik Lekang", email = "me@rolflekang.com" }]
 dependencies = [
   "click>=7,<9",
   "gitpython>=3.0.8,<4",
-  "twine>=4,<5",
   "requests>=2.25,<3",
   "jinja2>=3.1.2,<4",
   "python-gitlab>=2,<4",
@@ -32,10 +31,13 @@ dependencies = [
   "dataclasses==0.8; python_version < '3.7.0'",
   "importlib-resources==5.7",
   "pydantic>=1.10.2,<2",
+  "rich>=12.5.1",
+  "shellingham>=1.5.0.post1",
 ]
 
 [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"
@@ -45,7 +47,8 @@ Homepage = "https://python-semantic-release.readthedocs.io"
 docs = [
   "Sphinx==5.2.3",
   "sphinxcontrib-apidoc==0.3.0",
-  "sphinx-autobuild==2021.3.14",
+  "sphinx-autobuild==2021.03.14",
+  "furo>=2023.5.20",
 ]
 test = [
   "coverage[toml]>=6,<7",
@@ -56,6 +59,7 @@ test = [
   "pytest-cov>=4,<5",
   "responses==0.21.0",
   "requests-mock>=1.10.0,<2",
+  "types-pytest-lazy-fixture>=0.6.3.3",
 ]
 dev = ["tox", "isort", "black"]
 mypy = ["mypy", "types-requests"]
@@ -136,7 +140,10 @@ tag_format = "v{version}"
 commit_parser = "angular"
 commit_author = "semantic-release <semantic-release>"
 commit_message = "{version}\n\nAutomatically generated by python-semantic-release"
-build_command = "python setup.py sdist bdist_wheel"
+build_command = """
+    python -m pip install build~=0.10.0
+    python -m build .
+"""
 major_on_zero = true
 assets = []
 version_variables = ["semantic_release/__init__.py:__version__"]
@@ -190,44 +197,9 @@ prerelease_token = "alpha"
 [tool.semantic_release.remote]
 name = "origin"
 type = "github"
-ignore_token_for_push = true
+ignore_token_for_push = false
 token = { env = "GH_TOKEN" }
 
-[tool.semantic_release.upload]
+[tool.semantic_release.publish]
 dist_glob_patterns = ["dist/*"]
-upload_to_repository = true
 upload_to_vcs_release = true
-sign = false
-sign_with = "gpg"
-config_file = "~/.pypirc"
-skip_existing = false
-repository_name = "pypi"
-disable_progress_bar = false
-
-[tool.semantic_release.upload.pypi_token]
-env = "PYPI_TOKEN"
-
-[tool.semantic_release.upload.identity]
-env = "GPG_IDENTITIY"
-
-[tool.semantic_release.upload.username]
-env = "REPOSITORY_USERNAME"
-default_env = "TWINE_USERNAME"
-
-[tool.semantic_release.upload.password]
-env = "REPOSITORY_PASSWORD"
-default_env = "TWINE_PASSWORD"
-
-[tool.semantic_release.upload.non_interactive]
-env = "TWINE_NON_INTERACTIVE"
-default = "true"
-
-[tool.semantic_release.upload.cacert]
-env = "TWINE_CERT"
-
-[tool.semantic_release.upload.client_cert]
-env = "TWINE_CLIENT_CERT"
-
-[tool.semantic_release.upload.repository_url]
-env = "REPOSITORY_URL"
-default_env = "TWINE_REPOSITORY_URL"

{python-semantic-release-8.0.0a5 → 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.0a5
+Version: 8.0.0a7
 Summary: Automatic Semantic Versioning for Python projects
 Author-email: Rolf Erik Lekang <me@rolflekang.com>
 License: MIT
@@ -53,7 +53,15 @@ Read more about the setup and configuration in our `getting started guide`_.
 .. _GitHub Action: https://python-semantic-release.readthedocs.io/en/latest/automatic-releases/github-actions.html
 .. _conda-forge: https://anaconda.org/conda-forge/python-semantic-release
 
-.. |Test Status| image:: https://img.shields.io/github/workflow/status/relekang/python-semantic-release/Test%20%26%20Release?label=Tests&logo=github
+.. |Test Status| image:: https://img.shields.io/github/actions/workflow/status/python-semantic-release/python-semantic-release/main.yml?branch=master&label=Test%20Status&logo=github
+   :target: https://github.com/python-semantic-release/python-semantic-release/actions/workflows/main.yml
+   :alt: test-status
 .. |PyPI Version| image:: https://img.shields.io/pypi/v/python-semantic-release?label=PyPI&logo=pypi
+   :target: https://pypi.org/project/python-semantic-release/
+   :alt: pypi
 .. |conda-forge Version| image:: https://img.shields.io/conda/vn/conda-forge/python-semantic-release?logo=anaconda
-.. |Read the Docs Status| image:: https://img.shields.io/readthedocs/python-semantic-release?label=Read%20the%20Docs&logo=read-the-docs
+   :target: https://anaconda.org/conda-forge/python-semantic-release
+   :alt: conda-forge
+.. |Read the Docs Status| image:: https://img.shields.io/readthedocs/python-semantic-release?label=Read%20the%20Docs&logo=Read%20the%20Docs
+   :target: https://python-semantic-release.readthedocs.io/en/latest/
+   :alt: docs

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

@@ -24,6 +24,7 @@ semantic_release/cli/__init__.py
 semantic_release/cli/common.py
 semantic_release/cli/config.py
 semantic_release/cli/const.py
+semantic_release/cli/github_actions_output.py
 semantic_release/cli/masking_filter.py
 semantic_release/cli/util.py
 semantic_release/cli/commands/__init__.py
@@ -60,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
@@ -79,6 +81,7 @@ tests/unit/semantic_release/changelog/test_release_notes.py
 tests/unit/semantic_release/changelog/test_template.py
 tests/unit/semantic_release/cli/__init__.py
 tests/unit/semantic_release/cli/test_config.py
+tests/unit/semantic_release/cli/test_github_actions_output.py
 tests/unit/semantic_release/cli/test_masking_filter.py
 tests/unit/semantic_release/cli/test_version.py
 tests/unit/semantic_release/commit_parser/__init__.py
@@ -87,6 +90,7 @@ tests/unit/semantic_release/commit_parser/test_angular.py
 tests/unit/semantic_release/commit_parser/test_emoji.py
 tests/unit/semantic_release/commit_parser/test_scipy.py
 tests/unit/semantic_release/commit_parser/test_tag.py
+tests/unit/semantic_release/commit_parser/test_token.py
 tests/unit/semantic_release/commit_parser/test_util.py
 tests/unit/semantic_release/hvcs/__init__.py
 tests/unit/semantic_release/hvcs/test__base.py

{python-semantic-release-8.0.0a5 → 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.0a5 → python-semantic-release-8.0.0a7}/python_semantic_release.egg-info/requires.txt

@@ -1,6 +1,5 @@
 click<9,>=7
 gitpython<4,>=3.0.8
-twine<5,>=4
 requests<3,>=2.25
 jinja2<4,>=3.1.2
 python-gitlab<4,>=2
@@ -8,6 +7,8 @@ tomlkit~=0.10
 dotty-dict<2,>=1.3.0
 importlib-resources==5.7
 pydantic<2,>=1.10.2
+rich>=12.5.1
+shellingham>=1.5.0.post1
 
 [:python_version < "3.7.0"]
 dataclasses==0.8
@@ -20,7 +21,8 @@ black
 [docs]
 Sphinx==5.2.3
 sphinxcontrib-apidoc==0.3.0
-sphinx-autobuild==2021.3.14
+sphinx-autobuild==2021.03.14
+furo>=2023.5.20
 
 [mypy]
 mypy
@@ -35,3 +37,4 @@ pytest-lazy-fixture~=0.6.3
 pytest-cov<5,>=4
 responses==0.21.0
 requests-mock<2,>=1.10.0
+types-pytest-lazy-fixture>=0.6.3.3

{python-semantic-release-8.0.0a5 → 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.5"
+__version__ = "8.0.0-alpha.7"
 
 
 def setup_hook(argv: list[str]) -> None:

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

@@ -22,7 +22,7 @@ from semantic_release.cli.const import DEFAULT_CONFIG_FILE
 from semantic_release.cli.util import rprint
 from semantic_release.errors import InvalidConfiguration, NotAReleaseBranch
 
-FORMAT = "[%(name)s] %(module)s:%(funcName)s: %(message)s"
+FORMAT = "[%(name)s] %(levelname)s %(module)s.%(funcName)s: %(message)s"
 
 
 @click.group(
@@ -54,12 +54,20 @@ FORMAT = "[%(name)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
@@ -70,9 +78,6 @@ def main(
     Detect the next semantically correct version for a project based on the Git
     history, create and publish a changelog to a remote VCS, build a project.
 
-    If the project is written in Python, distributions can also be
-    uploaded to a remote Python package repository using twine.
-
     For more information, visit https://python-semantic-release.readthedocs.io/
     """
 
@@ -109,19 +114,24 @@ 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 and config_file.endswith(".toml"):
+        if config_file.endswith(".toml"):
             log.info(f"Loading TOML configuration from {config_file}")
             config_text = read_toml(config_file)
-        elif config_file and config_file.endswith(".json"):
+        elif config_file.endswith(".json"):
             log.info(f"Loading JSON configuration from {config_file}")
             raw_text = (Path() / config_file).resolve().read_text(encoding="utf-8")
             config_text = json.loads(raw_text)["semantic_release"]
-        elif config_file:
+        else:
             *_, suffix = config_file.split(".")
             ctx.fail(f"{suffix!r} is not a supported configuration format")
     except (FileNotFoundError, InvalidConfiguration) as exc:
@@ -133,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.0a7/semantic_release/cli/commands/publish.py

@@ -0,0 +1,46 @@
+import logging
+
+import click
+
+from semantic_release.cli.util import noop_report
+from semantic_release.version import tags_and_versions
+
+log = logging.getLogger(__name__)
+
+
+@click.command(
+    short_help="Publish distributions to VCS Releases",
+    context_settings={
+        "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, tag: str = "latest") -> None:
+    """
+    Build and publish a distribution to a VCS release.
+    """
+    runtime = ctx.obj
+    repo = runtime.repo
+    hvcs_client = runtime.hvcs_client
+    translator = runtime.version_translator
+    dist_glob_patterns = runtime.dist_glob_patterns
+
+    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 "
+            + ", ".join(repr(g) for g in dist_glob_patterns)
+            + " to a remote VCS release, if supported"
+        )
+        ctx.exit(0)
+
+    log.info("Uploading distributions to release")
+    for pattern in dist_glob_patterns:
+        hvcs_client.upload_dists(tag=tag, dist_glob=pattern)

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

@@ -2,11 +2,13 @@ from __future__ import annotations
 
 import logging
 import os
+import subprocess
 from contextlib import nullcontext
 from datetime import datetime
 from typing import TYPE_CHECKING, ContextManager
 
 import click
+import shellingham  # type: ignore[import]
 
 from semantic_release.changelog import ReleaseHistory, environment, recursive_render
 from semantic_release.changelog.context import make_changelog_context
@@ -14,8 +16,9 @@ from semantic_release.cli.common import (
     render_default_changelog_file,
     render_release_notes,
 )
+from semantic_release.cli.github_actions_output import VersionGitHubActionsOutput
 from semantic_release.cli.util import indented, noop_report, rprint
-from semantic_release.const import DEFAULT_VERSION
+from semantic_release.const import DEFAULT_SHELL, DEFAULT_VERSION
 from semantic_release.enums import LevelBump
 from semantic_release.version import (
     Version,
@@ -85,6 +88,21 @@ def apply_version_to_source_files(
     return paths
 
 
+def shell(cmd: str, *, check: bool = True) -> subprocess.CompletedProcess:
+    shell: str | None
+    try:
+        shell, _ = shellingham.detect_shell()
+    except shellingham.ShellDetectionFailure:
+        log.warning("failed to detect shell, using default shell: %s", DEFAULT_SHELL)
+        log.debug("stack trace", exc_info=True)
+        shell = DEFAULT_SHELL
+
+    if not shell:
+        raise TypeError("'shell' is None")
+
+    return subprocess.run([shell, "-c", cmd], check=check)
+
+
 @click.command(
     short_help="Detect and apply a new version",
     context_settings={
@@ -152,7 +170,14 @@ def apply_version_to_source_files(
     "--build-metadata",
     "build_metadata",
     default=os.getenv("PSR_BUILD_METADATA"),
-    help="Build metadata to append to the latest version",
+    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(
@@ -166,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
@@ -200,7 +226,11 @@ def version(
     commit_author = runtime.commit_author
     commit_message = runtime.commit_message
     major_on_zero = runtime.major_on_zero
+    build_command = runtime.build_command
     opts = runtime.global_cli_options
+    gha_output = VersionGitHubActionsOutput()
+
+    ctx.call_on_close(gha_output.write_if_possible)
 
     if prerelease_token:
         log.info("Forcing use of %s as the prerelease token", prerelease_token)
@@ -254,14 +284,26 @@ def version(
     if build_metadata:
         new_version.build_metadata = build_metadata
 
-    # If the new version has already been released, we fail and abort
+    gha_output.released = False
+    gha_output.version = new_version
+
+    # 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(
@@ -276,6 +318,24 @@ def version(
     )
     all_paths_to_add = files_with_new_version_written + (assets or [])
 
+    # Build distributions before committing any changes - this way if the
+    # build fails, modifications to the source code won't be committed
+    if skip_build:
+        rprint("[bold orange1]Skipping build due to --skip-build flag")
+    elif not build_command:
+        rprint("[green]No build command specified, skipping")
+    elif runtime.global_cli_options.noop:
+        noop_report(f"would have run the build_command {build_command}")
+    else:
+        try:
+            log.info("Running build command %s", build_command)
+            rprint(
+                f"[bold green]:hammer_and_wrench: Running build command: {build_command}"
+            )
+            shell(build_command, check=True)
+        except subprocess.CalledProcessError as exc:
+            ctx.fail(str(exc))
+
     # Commit changes
     if commit_changes and opts.noop:
         # Indents the newlines so that terminal formatting is happy - note the
@@ -450,10 +510,11 @@ def version(
                 )
             )
         else:
-            # Wrap in GitCommandError handling - remove token
             repo.git.push(remote_url, active_branch)
             repo.git.push("--tags", remote_url, active_branch)
 
+    gha_output.released = True
+
     if make_vcs_release and opts.noop:
         noop_report(
             f"would have created a release for the tag {new_version.as_tag()!r}"