Merge pull request #420 from boromir674/dev

Release v2.6.1

Author: boromir674

CHANGELOG.rst

@@ -3,6 +3,30 @@ Changelog
 =========
 
 
+2.6.1 (2025-05-16)
+==================
+
+Changes
+^^^^^^^
+
+fix
+"""
+- --version CLI flag
+
+test
+""""
+- fix integration tests
+
+documentation
+"""""""""""""
+- update 'Topic to Integration' Dev Process Guide
+
+chore
+"""""
+- sem ver bump to 2.6.1
+- update terminal based release script
+
+
 2.6.0 (2025-05-15)
 ==================
 

README.md

@@ -3,7 +3,7 @@
 [![Build Status](https://img.shields.io/github/actions/workflow/status/boromir674/cookiecutter-python-package/test.yaml?link=https%3A%2F%2Fgithub.com%2Fboromir674%2Fcookiecutter-python-package%2Factions%2Fworkflows%2Ftest.yaml%3Fquery%3Dbranch%253Amaster)](https://github.com/boromir674/cookiecutter-python-package/actions/workflows/test.yaml?query=branch%3Amaster) [![Coverage](https://img.shields.io/codecov/c/github/boromir674/cookiecutter-python-package/master?logo=codecov)](https://app.codecov.io/gh/boromir674/cookiecutter-python-package) [![Docs](https://img.shields.io/readthedocs/python-package-generator/master?logo=readthedocs&logoColor=lightblue)](https://python-package-generator.readthedocs.io/en/master/) [![Maintainability](https://api.codeclimate.com/v1/badges/1d347d7dfaa134fd944e/maintainability)](https://codeclimate.com/github/boromir674/cookiecutter-python-package/maintainability)
 [![Release Version](https://img.shields.io/pypi/v/cookiecutter_python)](https://pypi.org/project/cookiecutter-python/) [![Wheel](https://img.shields.io/pypi/wheel/cookiecutter-python?color=green&label=wheel)](https://pypi.org/project/cookiecutter-python) [![Tech Debt](https://img.shields.io/codeclimate/tech-debt/boromir674/cookiecutter-python-package)](https://codeclimate.com/github/boromir674/cookiecutter-python-package/) [![Codacy](https://app.codacy.com/project/badge/Grade/5be4a55ff1d34b98b491dc05e030f2d7)](https://app.codacy.com/gh/boromir674/cookiecutter-python-package/dashboard?utm_source=github.com&utm_medium=referral&utm_content=boromir674/cookiecutter-python-package&utm_campaign=Badge_Grade)
 [![Supported Versions](https://img.shields.io/pypi/pyversions/cookiecutter-python?color=blue&label=python&logo=python&logoColor=%23ccccff)](https://pypi.org/project/cookiecutter-python)
-[![PyPI Stats](https://img.shields.io/pypi/dm/cookiecutter-python?logo=pypi&logoColor=%23849ED9&color=%23849ED9)](https://pypistats.org/packages/cookiecutter-python) [![Commits Since Tag](https://img.shields.io/github/commits-since/boromir674/cookiecutter-python-package/v2.6.0/master?color=blue&logo=github)](https://github.com/boromir674/cookiecutter-python-package/compare/v2.6.0..master) [![Commits Since Release](https://img.shields.io/github/commits-since/boromir674/cookiecutter-python-package/latest?color=blue&logo=semver&sort=semver)](https://github.com/boromir674/cookiecutter-python-package/releases)
+[![PyPI Stats](https://img.shields.io/pypi/dm/cookiecutter-python?logo=pypi&logoColor=%23849ED9&color=%23849ED9)](https://pypistats.org/packages/cookiecutter-python) [![Commits Since Tag](https://img.shields.io/github/commits-since/boromir674/cookiecutter-python-package/v2.6.1/master?color=blue&logo=github)](https://github.com/boromir674/cookiecutter-python-package/compare/v2.6.1..master) [![Commits Since Release](https://img.shields.io/github/commits-since/boromir674/cookiecutter-python-package/latest?color=blue&logo=semver&sort=semver)](https://github.com/boromir674/cookiecutter-python-package/releases)
 [![License](https://img.shields.io/github/license/boromir674/cookiecutter-python-package)](https://github.com/boromir674/cookiecutter-python-package/blob/master/LICENSE) [![OpenSSF](https://bestpractices.coreinfrastructure.org/projects/5988/badge)](https://bestpractices.coreinfrastructure.org/en/projects/5988) [![Ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://docs.astral.sh/ruff/) [![Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
 

docs/topics/development/topic_branch_to_dev.md

@@ -43,8 +43,9 @@ Prerequisites:
     <li><b>Open PR</b> to Integration Branch
 
         ```sh
-        git checkout ${DEV_BR} && git pull && git checkout -
-        git rebase ${DEV_BR} && git push -f && gh pr create --base ${DEV_BR}
+        git checkout ${DEV_BR} && git pull && git rebase ${MAIN_BR} && git push -f
+        git checkout - && git rebase ${DEV_BR}
+        git push -f && gh pr create --base ${DEV_BR}
         ```
 
     </li>

pyproject.toml

@@ -14,7 +14,7 @@ build-backend = "poetry.core.masonry.api"
 name = "cookiecutter_python"
 ### ... ###
 
-version = "2.6.0"
+version = "2.6.1"
 description = "1-click Generator of Python Project, from Template with streamlined \"DevOps\" using a powerful CI/CD Pipeline."
 readme = "README.md"
 license = "AGPL-3.0-only"
@@ -74,7 +74,7 @@ maintainers = [
 license = {text = "AGPL-3.0-only"}
 
 name = "cookiecutter_python"
-version = "2.6.0"
+version = "2.6.1"
 description = "1-click Generator of Python Project, from Template with streamlined \"DevOps\" using a powerful CI/CD Pipeline."
 readme = "README.md"
 # keywords = []

scripts/terminal-based-release.sh

@@ -168,10 +168,13 @@ git push origin -f "$RC_TAG"
 echo
 echo "Release Candidate Pipeline Triggered !"
 
+
 # press any key to continue
-read -ep "Please watch the CI/CD Pipeline to succeed (press any key to continue to 'live watch') !" -n1 -s
+read -ep "Please run 'gh run watch' to watch the CI/CD Pipeline (press any key to continue)" -n1 -s
 
-gh run watch
+# TODO: try to implement the below; currently after gh run watch finishes it stops execution of the sshell script!
+# read -ep "Please watch the CI/CD Pipeline to succeed (press any key to continue to 'live watch') !" -n1 -s
+# gh run watch
 
 echo "========================="
 echo "Assuming CI/CD Pipeline Succeeded !"

src/cookiecutter_python/__init__.py

@@ -1,3 +1,3 @@
-__version__ = '2.6.0'
+__version__ = '2.6.1'
 
 from . import _logging  # noqa

src/cookiecutter_python/cli.py

@@ -2,6 +2,7 @@
 
 import os
 import sys
+import typing as t
 
 import click
 
@@ -17,10 +18,10 @@
 
 def version_msg():
     """Message about Python Generator version, location and Python version."""
-    python_version = sys.version[:3]
+    python_version: t.Tuple[int, int, int] = sys.version_info[:3]
     message = u'Python Generator %(version)s from {} (Python {})'
     location = os.path.dirname(this_file_location)
-    return message.format(location, python_version)
+    return message.format(location, ".".join(map(str, python_version)))
 
 
 @click.command(context_settings=dict(help_option_names=[u'-h', u'--help']))

tests/test_build_backend_sdist.py

@@ -146,6 +146,7 @@ def sdist_expected_correct_file_structure():
         # 'src/stubs/requests_futures/sessions.pyi',
     )
     TESTS = (
+        'tests/test_version_string.py',
         'tests/test_git_sdk.py',
         'tests/test_git_porcelain.py',
         'tests/test_is_repo_clean_function.py',

tests/test_version_string.py

@@ -0,0 +1,50 @@
+from pathlib import Path
+
+import pytest
+
+
+def test_version_msg_function_returns_expected_string(distro_loc: Path):
+    # GIVEN the version_msg function
+    from cookiecutter_python.cli import version_msg
+
+    # WHEN the version_msg function is called
+    result: str = version_msg()
+
+    # THEN it should return the expected string
+    import sys
+
+    EXPECTED_PYTHON_VERSION: str = ".".join(map(str, sys.version_info[:3]))
+
+    EXPECTED_PARENT_DIR_OF_COOKIECUTTER_PYTHON: Path = distro_loc.parent
+
+    assert result == (
+        f'Python Generator %(version)s from {EXPECTED_PARENT_DIR_OF_COOKIECUTTER_PYTHON} (Python {EXPECTED_PYTHON_VERSION})'
+    )
+
+
+@pytest.mark.runner_setup(mix_stderr=False)
+def test_cli_version_flag_returns_expected_string(
+    distro_loc: Path,
+    isolated_cli_runner,
+):
+    from cookiecutter_python import __version__
+    from cookiecutter_python.cli import main
+
+    result = isolated_cli_runner.invoke(
+        main,
+        args=['--version'],
+        input=None,
+        env=None,
+        catch_exceptions=False,
+    )
+    assert result.exit_code == 0
+
+    import sys
+
+    EXPECTED_PYTHON_VERSION: str = ".".join(map(str, sys.version_info[:3]))
+
+    EXPECTED_PARENT_DIR_OF_COOKIECUTTER_PYTHON: Path = distro_loc.parent
+
+    assert result.stdout == (
+        f'Python Generator {__version__} from {EXPECTED_PARENT_DIR_OF_COOKIECUTTER_PYTHON} (Python {EXPECTED_PYTHON_VERSION})\n'
+    )