python-semantic-release 9.4.1__tar.gz → 9.4.2__tar.gz

{python-semantic-release-9.4.1/python_semantic_release.egg-info → python_semantic_release-9.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-semantic-release
-Version: 9.4.1
+Version: 9.4.2
 Summary: Automatic Semantic Versioning for Python projects
 Author-email: Rolf Erik Lekang <me@rolflekang.com>
 License: MIT
@@ -30,13 +30,13 @@ Requires-Dist: tomlkit~=0.11
 Requires-Dist: dotty-dict~=1.3
 Requires-Dist: importlib-resources~=6.0
 Requires-Dist: pydantic~=2.0
-Requires-Dist: rich~=12.5
+Requires-Dist: rich~=13.0
 Requires-Dist: shellingham~=1.5
 Provides-Extra: docs
 Requires-Dist: Sphinx~=6.0; extra == "docs"
 Requires-Dist: sphinxcontrib-apidoc==0.5.0; extra == "docs"
 Requires-Dist: sphinx-autobuild==2024.2.4; extra == "docs"
-Requires-Dist: furo~=2023.3; extra == "docs"
+Requires-Dist: furo~=2024.1; extra == "docs"
 Provides-Extra: test
 Requires-Dist: coverage[toml]~=7.0; extra == "test"
 Requires-Dist: pytest~=7.0; extra == "test"

{python-semantic-release-9.4.1 → python_semantic_release-9.4.2}/docs/commands.rst

@@ -165,7 +165,7 @@ Note if the version can not be found nothing will be printed.
 .. _cmd-version-option-print-last-released-tag:
 
 ``--print-last-released-tag``
-***************
+*****************************
 
 Same as the :ref:`cmd-version-option-print-last-released` flag but prints the
 complete tag name (ex. ``v1.0.0`` or ``py-v1.0.0``) instead of the raw version

{python-semantic-release-9.4.1 → python_semantic_release-9.4.2}/docs/configuration.rst

@@ -100,11 +100,15 @@ In this structure:
 Settings
 --------
 
+----
+
 .. _config-root:
 
 ``[tool.semantic_release]``
 ***************************
 
+----
+
 .. _config-assets:
 
 ``assets (List[str])``
@@ -115,6 +119,8 @@ in addition to any files modified by writing the new version.
 
 **Default:** ``[]``
 
+----
+
 .. _config-branches:
 
 ``branches``
@@ -131,6 +137,8 @@ This setting is discussed in more detail at :ref:`multibranch-releases`
     prerelease_token = "rc"
     prerelease = false
 
+----
+
 .. _config-build-command:
 
 ``build_command (Optional[str])``
@@ -140,6 +148,8 @@ Command to use when building the current project during :ref:`cmd-version`
 
 **Default:** ``None`` (not specified)
 
+----
+
 .. _config-commit_author:
 
 ``commit_author (str)``
@@ -156,6 +166,8 @@ Author used in commits in the format ``name <email>``.
 
 **Default:** ``semantic-release <semantic-release>``
 
+----
+
 .. _config-commit-message:
 
 ``commit_message (str)``
@@ -170,6 +182,8 @@ adding the old message pattern(s) to :ref:`exclude_commit_patterns <config-chang
 
 **Default:** ``"{version}\n\nAutomatically generated by python-semantic-release"``
 
+----
+
 .. _config-commit-parser:
 
 ``commit_parser (str)``
@@ -191,6 +205,8 @@ For more information see :ref:`commit-parsing`.
 
 **Default:** ``"angular"``
 
+----
+
 .. _config-commit-parser-options:
 
 ``commit_parser_options (Dict[str, Any])``
@@ -258,6 +274,8 @@ the expections from ``commit_parser`` value to default options value.
 :ref:`commit_parser <config-commit-parser>` as indicated above.
 
 
+----
+
 .. _config-logging-use-named-masks:
 
 ``logging_use_named_masks (bool)``
@@ -268,6 +286,8 @@ identifying which secrets were replaced, or use a generic string to mask them.
 
 **Default:** ``false``
 
+----
+
 .. _config-allow-zero-version:
 
 ``allow_zero_version (bool)``
@@ -288,6 +308,8 @@ the :ref:`major_on_zero` setting is ignored.
 
 **Default:** ``true``
 
+----
+
 .. _config-major-on-zero:
 
 ``major_on_zero (bool)``
@@ -316,6 +338,8 @@ When :ref:`allow_zero_version` is set to ``false``, this setting is ignored.
 
 **Default:** ``true``
 
+----
+
 .. _config-tag-format:
 
 ``tag_format (str)``
@@ -350,6 +374,8 @@ Tags which do not match this format will not be considered as versions of your p
 
 **Default:** ``"v{version}"``
 
+----
+
 .. _config-version-variables:
 
 ``version_variables (List[str])``
@@ -368,6 +394,8 @@ specified in ``file:variable`` format. For example:
 
 **Default:** ``[]``
 
+----
+
 .. _config-version-toml:
 
 ``version_toml (List[str])``
@@ -385,11 +413,15 @@ dotted notation to indicate the key for which the value represents the version:
 
 **Default:** ``[]``
 
+----
+
 .. _config-changelog:
 
 ``[tool.semantic_release.changelog]``
 *************************************
 
+----
+
 .. _config-changelog-template-dir:
 
 ``template_dir (str)``
@@ -402,6 +434,8 @@ This option is discussed in more detail at :ref:`changelog-templates`
 
 **Default:** ``"templates"``
 
+----
+
 .. _config-changelog-changelog-file:
 
 ``changelog_file (str)``
@@ -411,6 +445,8 @@ Specify the name of the changelog file (after template rendering has taken place
 
 **Default:** ``"CHANGELOG.md"``
 
+----
+
 .. _config-changelog-exclude-commit-patterns:
 
 ``exclude_commit_patterns (List[str])``
@@ -426,6 +462,8 @@ The patterns in this list are treated as regular expressions.
 
 **Default:** ``[]``
 
+----
+
 .. _config-changelog-environment:
 
 ``[tool.semantic_release.changelog.environment]``
@@ -439,6 +477,8 @@ The patterns in this list are treated as regular expressions.
 
 .. _`jinja2.Environment`: https://jinja.palletsprojects.com/en/3.1.x/api/#jinja2.Environment
 
+----
+
 .. _config-changelog-environment-block-start-string:
 
 ``block_start_string (str)``
@@ -448,6 +488,8 @@ This setting is passed directly to the `jinja2.Environment`_ constructor.
 
 **Default:** ``"{%"``
 
+----
+
 .. _config-changelog-environment-block-end-string:
 
 ``block_end_string (str)``
@@ -457,6 +499,8 @@ This setting is passed directly to the `jinja2.Environment`_ constructor.
 
 **Default:** ``"%}"``
 
+----
+
 .. _config-changelog-environment-variable-start-string:
 
 ``variable_start_string (str)``
@@ -466,6 +510,8 @@ This setting is passed directly to the `jinja2.Environment`_ constructor.
 
 **Default:** ``"{{"``
 
+----
+
 .. _config-changelog-environment-variable-end-string:
 
 ``variable_end_string (str)``
@@ -475,6 +521,8 @@ This setting is passed directly to the `jinja2.Environment`_ constructor.
 
 **Default:** ``"}}"``
 
+----
+
 .. _config-changelog-environment-comment-start-string:
 
 ``comment_start_string (str)``
@@ -484,6 +532,8 @@ This setting is passed directly to the `jinja2.Environment`_ constructor.
 
 **Default:** ``{#``
 
+----
+
 .. _config-changelog-environment-comment-end-string:
 
 ``comment_end_string (str)``
@@ -493,6 +543,8 @@ This setting is passed directly to the `jinja2.Environment`_ constructor.
 
 **Default:** ``"#}"``
 
+----
+
 .. _config-changelog-environment-line-statement-prefix:
 
 ``line_statement_prefix (Optional[str])``
@@ -502,6 +554,8 @@ This setting is passed directly to the `jinja2.Environment`_ constructor.
 
 **Default:** ``None`` (not specified)
 
+----
+
 .. _config-changelog-environment-line-comment-prefix:
 
 ``line_comment_prefix (Optional[str])``
@@ -511,6 +565,8 @@ This setting is passed directly to the `jinja2.Environment`_ constructor.
 
 **Default:** ``None`` (not specified)
 
+----
+
 .. _config-changelog-environment-trim-blocks:
 
 ``trim_blocks (bool)``
@@ -520,6 +576,8 @@ This setting is passed directly to the `jinja2.Environment`_ constructor.
 
 **Default:** ``false``
 
+----
+
 .. _config-changelog-environment-lstrip-blocks:
 
 ``lstrip_blocks (bool)``
@@ -529,6 +587,8 @@ This setting is passed directly to the `jinja2.Environment`_ constructor.
 
 **Default:** ``false``
 
+----
+
 .. _config-changelog-environment-newline-sequence:
 
 ``newline_sequence (Literal["\n", "\r", "\r\n"])``
@@ -538,6 +598,8 @@ This setting is passed directly to the `jinja2.Environment`_ constructor.
 
 **Default:** ``"\n"``
 
+----
+
 .. _config-changelog-environment-keep-trailing-newline:
 
 ``keep_trailing_newline (bool)``
@@ -547,6 +609,8 @@ This setting is passed directly to the `jinja2.Environment`_ constructor.
 
 **Default:** ``false``
 
+----
+
 .. _config-changelog-environment-extensions:
 
 ``extensions (List[str])``
@@ -556,6 +620,7 @@ This setting is passed directly to the `jinja2.Environment`_ constructor.
 
 **Default:** ``[]``
 
+----
 
 .. _config-changelog-environment-autoescape:
 
@@ -578,35 +643,98 @@ constructor.
 
 **Default:** ``true``
 
+----
+
 .. _config-remote:
 
-``[tool.semantic_release.remote]``
-**********************************
+``remote``
+**********
 
-.. _config-remote-name:
+.. note::
+    The remote configuration is a group of settings that configure PSR's integration
+    with remote version control systems.
+
+    **pyproject.toml:** ``[tool.semantic_release.remote]``
+
+----
 
-``name (str)``
+.. _config-remote-api_domain:
+
+``api_domain``
 """"""""""""""
 
-Name of the remote to push to using ``git push -u $name <branch_name>``
+**Type:** ``Optional[str | Dict['env', str]]``
 
-**Default:** ``"origin"``
+The hosting domain for the API of your remote HVCS if different than the ``domain``.
+Generally, this will be used to specify a separate subdomain that is used for API
+calls rather than the primary domain (ex. ``api.github.com``).
 
-.. _config-remote-type:
+**Most on-premise HVCS installations will NOT use this setting!** Whether or not
+this value is used depends on the HVCS configured (and your server administration)
+in the :ref:`remote.type <config-remote-type>` setting and used in tadem with the
+:ref:`remote.domain <config-remote-domain>` setting.
 
-``type (str)``
-""""""""""""""
+When using a custom :ref:`remote.domain <config-remote-domain>` and a HVCS
+:ref:`remote.type <config-remote-type>` that is configured with a separate domain
+or sub-domain for API requests, this value is used to configure the location of API
+requests that are sent from PSR.
 
-The type of the remote VCS. Currently, Python Semantic Release supports ``"github"``,
-``"gitlab"``, ``"gitea"`` and ``"bitbucket"``. Not all functionality is available with all
-remote types, but we welcome pull requests to help improve this!
+Most on-premise or self-hosted HVCS environments will use a path prefix to handle inbound
+API requests, which means this value will ignored.
 
-**Default:** ``"github"``
+PSR knows the expected api domains for known cloud services and their associated
+api domains which means this value is not necessary to explicitly define for services
+as ``bitbucket.org``, and ``github.com``.
+
+Including the protocol schemes, such as ``https://``, for the API domain is optional.
+Secure ``HTTPS`` connections are assumed unless the setting of
+:ref:`remote.insecure <config-remote-insecure>` is ``True``.
+
+**Default:** ``None``
+
+----
+
+.. _config-remote-domain:
+
+``domain``
+""""""""""
+
+**Type:** ``Optional[str | Dict['env', str]]``
+
+The host domain for your HVCS server. This setting is used to support on-premise
+installations of HVCS providers with custom domain hosts.
+
+If you are using the official domain of the associated
+:ref:`remote.type <config-remote-type>`, this value is not required. PSR will use the
+default domain value for the :ref:`remote.type <config-remote-type>` when not specified.
+For example, when ``remote.type="github"`` is specified the default domain of
+``github.com`` is used.
+
+Including the protocol schemes, such as ``https://``, for the domain value is optional.
+Secure ``HTTPS`` connections are assumed unless the setting of
+:ref:`remote.insecure <config-remote-insecure>` is ``True``.
+
+This setting also supports reading from an environment variable for ease-of-use
+in CI pipelines. See :ref:`Environment Variable <config-environment-variables>` for
+more information. Depending on the :ref:`remote.type <config-remote-type>`, the default
+environment variable for the default domain's CI pipeline environment will automatically
+be checked so this value is not required in default environments.  For example, when
+``remote.type="gitlab"`` is specified, PSR will look to the ``CI_SERVER_URL`` environment
+variable when ``remote.domain`` is not specified.
+
+**Default:** ``None``
+
+.. seealso::
+   - :ref:`remote.api_domain <config-remote-api-domain>`
+
+----
 
 .. _config-remote-ignore-token-for-push:
 
-``ignore_token_for_push (bool)``
-""""""""""""""""""""""""""""""""
+``ignore_token_for_push``
+"""""""""""""""""""""""""
+
+**Type:** ``bool``
 
 If set to ``True``, ignore the authentication token when pushing changes to the remote.
 This is ideal, for example, if you already have SSH keys set up which can be used for
@@ -614,10 +742,87 @@ pushing.
 
 **Default:** ``False``
 
+----
+
+.. _config-remote-insecure:
+
+``insecure``
+""""""""""""
+
+**Type:** ``bool``
+
+Insecure is used to allow non-secure ``HTTP`` connections to your HVCS server. If set to
+``True``, any domain value passed will assume ``http://`` if it is not specified and allow
+it. When set to ``False`` (implicitly or explicitly), it will force ``https://`` communications.
+
+When a custom ``domain`` or ``api_domain`` is provided as a configuration, this flag governs
+the protocol scheme used for those connections. If the protocol scheme is not provided in
+the field value, then this ``insecure`` option defines whether ``HTTP`` or ``HTTPS`` is
+used for the connection. If the protocol scheme is provided in the field value, it must
+match this setting or it will throw an error.
+
+The purpose of this flag is to prevent any typos in provided ``domain`` and ``api_domain``
+values that accidently specify an insecure connection but allow users to toggle the protection
+scheme off when desired.
+
+**Default:** ``False``
+
+----
+
+.. _config-remote-name:
+
+``name``
+""""""""
+
+**Type:** ``str``
+
+Name of the remote to push to using ``git push -u $name <branch_name>``
+
+**Default:** ``"origin"``
+
+----
+
+.. _config-remote-url:
+
+``url``
+"""""""
+
+**Type:** ``Optional[str | Dict['env', str]]``
+
+An override setting used to specify the remote upstream location of ``git push``.
+
+**Not commonly used!** This is used to override the derived upstream location when
+the desired push location is different than the location the repository was cloned
+from.
+
+This setting will override the upstream location url that would normally be derived
+from the :ref:`remote.name <config-remote-name>` location of your git repository.
+
+**Default:** ``None``
+
+----
+
+.. _config-remote-type:
+
+``type``
+""""""""
+
+**Type:** ``Literal["bitbucket", "gitea", "github", "gitlab"]``
+
+The type of the remote VCS. Currently, Python Semantic Release supports ``"github"``,
+``"gitlab"``, ``"gitea"`` and ``"bitbucket"``. Not all functionality is available with all
+remote types, but we welcome pull requests to help improve this!
+
+**Default:** ``"github"``
+
+----
+
 .. _config-remote-token:
 
-``token (Dict['env': str])``
-""""""""""""""""""""""""""""
+``token``
+"""""""""
+
+**Type:** ``Optional[str | Dict['env', str]]``
 
 :ref:`Environment Variable <config-environment-variables>` from which to source the
 authentication token for the remote VCS. Common examples include ``"GH_TOKEN"``,
@@ -654,12 +859,15 @@ default token value will be for each remote type.
 **Default:** ``{ env = "<envvar name>" }``, where ``<envvar name>`` depends on
 :ref:`remote.type <config-remote-type>` as indicated above.
 
+----
 
 .. _config-publish:
 
 ``[tool.semantic_release.publish]``
 ***********************************
 
+----
+
 .. _config-publish-dist-glob-patterns:
 
 ``dist_glob_patterns (List[str])``
@@ -670,6 +878,8 @@ list should be a string containing a Unix-style glob pattern.
 
 **Default:** ``["dist/*"]``
 
+----
+
 .. _config-publish-upload-to-vcs-release:
 
 ``upload_to_vcs_release (bool)``

{python-semantic-release-9.4.1 → python_semantic_release-9.4.2}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-semantic-release"
-version = "9.4.1"
+version = "9.4.2"
 description = "Automatic Semantic Versioning for Python projects"
 requires-python = ">=3.8"
 license = { text = "MIT" }
@@ -32,7 +32,7 @@ dependencies = [
   "dotty-dict ~= 1.3",
   "importlib-resources ~= 6.0",
   "pydantic ~= 2.0",
-  "rich ~= 12.5",
+  "rich ~= 13.0",
   "shellingham ~= 1.5",
 ]
 
@@ -52,7 +52,7 @@ docs = [
   "Sphinx ~= 6.0",
   "sphinxcontrib-apidoc == 0.5.0",
   "sphinx-autobuild == 2024.2.4",
-  "furo ~= 2023.3",
+  "furo ~= 2024.1",
 ]
 test = [
   "coverage[toml] ~= 7.0",

{python-semantic-release-9.4.1 → python_semantic_release-9.4.2/python_semantic_release.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-semantic-release
-Version: 9.4.1
+Version: 9.4.2
 Summary: Automatic Semantic Versioning for Python projects
 Author-email: Rolf Erik Lekang <me@rolflekang.com>
 License: MIT
@@ -30,13 +30,13 @@ Requires-Dist: tomlkit~=0.11
 Requires-Dist: dotty-dict~=1.3
 Requires-Dist: importlib-resources~=6.0
 Requires-Dist: pydantic~=2.0
-Requires-Dist: rich~=12.5
+Requires-Dist: rich~=13.0
 Requires-Dist: shellingham~=1.5
 Provides-Extra: docs
 Requires-Dist: Sphinx~=6.0; extra == "docs"
 Requires-Dist: sphinxcontrib-apidoc==0.5.0; extra == "docs"
 Requires-Dist: sphinx-autobuild==2024.2.4; extra == "docs"
-Requires-Dist: furo~=2023.3; extra == "docs"
+Requires-Dist: furo~=2024.1; extra == "docs"
 Provides-Extra: test
 Requires-Dist: coverage[toml]~=7.0; extra == "test"
 Requires-Dist: pytest~=7.0; extra == "test"

{python-semantic-release-9.4.1 → python_semantic_release-9.4.2}/python_semantic_release.egg-info/requires.txt

@@ -8,7 +8,7 @@ tomlkit~=0.11
 dotty-dict~=1.3
 importlib-resources~=6.0
 pydantic~=2.0
-rich~=12.5
+rich~=13.0
 shellingham~=1.5
 
 [dev]
@@ -20,7 +20,7 @@ ruff==0.3.5
 Sphinx~=6.0
 sphinxcontrib-apidoc==0.5.0
 sphinx-autobuild==2024.2.4
-furo~=2023.3
+furo~=2024.1
 
 [mypy]
 mypy==1.9.0

{python-semantic-release-9.4.1 → python_semantic_release-9.4.2}/semantic_release/__init__.py

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

{python-semantic-release-9.4.1 → python_semantic_release-9.4.2}/semantic_release/cli/commands/version.py

@@ -11,6 +11,7 @@ import click
 import shellingham  # type: ignore[import]
 from click_option_group import MutuallyExclusiveOptionGroup, optgroup
 from git.exc import GitCommandError
+from requests import HTTPError
 
 from semantic_release.changelog import ReleaseHistory, environment, recursive_render
 from semantic_release.changelog.context import make_changelog_context
@@ -23,6 +24,7 @@ from semantic_release.cli.github_actions_output import VersionGitHubActionsOutpu
 from semantic_release.cli.util import indented, noop_report, rprint
 from semantic_release.const import DEFAULT_SHELL, DEFAULT_VERSION
 from semantic_release.enums import LevelBump
+from semantic_release.errors import UnexpectedResponse
 from semantic_release.version import Version, next_version, tags_and_versions
 
 log = logging.getLogger(__name__)
@@ -633,6 +635,21 @@ def version(  # noqa: C901
                     release_notes=release_notes,
                     prerelease=new_version.is_prerelease,
                 )
+            except HTTPError as err:
+                log.exception(err)
+                ctx.fail(str.join("\n", [str(err), "Failed to create release!"]))
+            except UnexpectedResponse as err:
+                log.exception(err)
+                ctx.fail(
+                    str.join(
+                        "\n",
+                        [
+                            str(err),
+                            "Unexpected response from remote VCS!",
+                            "Before re-running, make sure to clean up any artifacts on the hvcs that may have already been created.",
+                        ],
+                    )
+                )
             except Exception as e:
                 log.exception(e)
                 ctx.fail(str(e))
@@ -641,6 +658,9 @@ def version(  # noqa: C901
                 log.info("Uploading asset %s", asset)
                 try:
                     hvcs_client.upload_asset(release_id, asset)
+                except HTTPError as err:
+                    log.exception(err)
+                    ctx.fail(str.join("\n", [str(err), "Failed to upload asset!"]))
                 except Exception as e:
                     log.exception(e)
                     ctx.fail(str(e))